This file is indexed.

/usr/share/doc/libqof-doc/html/structQofBookMergeData.html is in libqof-doc 0.8.7-1ubuntu1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.6"/>
<title>QOF: QofBookMergeData Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td style="padding-left: 0.5em;">
   <div id="projectname">QOF
   &#160;<span id="projectnumber">0.8.7</span>
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</span></a></li>
      <li><a href="pages.html"><span>Related&#160;Pages</span></a></li>
      <li><a href="modules.html"><span>Modules</span></a></li>
      <li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="files.html"><span>Files</span></a></li>
    </ul>
  </div>
  <div id="navrow2" class="tabs2">
    <ul class="tablist">
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="classes.html"><span>Data&#160;Structure&#160;Index</span></a></li>
      <li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">QofBookMergeData Struct Reference<div class="ingroups"><a class="el" href="group__BookMerge.html">Merge:  Merging QofBook structures</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p>mergeData contains the essential context data for any merge.  
 <a href="structQofBookMergeData.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:ae8b811aac4ad4d05ca3a16dc6587814a"><td class="memItemLeft" align="right" valign="top">GSList *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structQofBookMergeData.html#ae8b811aac4ad4d05ca3a16dc6587814a">mergeObjectParams</a></td></tr>
<tr class="separator:ae8b811aac4ad4d05ca3a16dc6587814a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ad8cf2bb4a79b9d63ac8c6b2316a5224a"><td class="memItemLeft" align="right" valign="top">GList *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structQofBookMergeData.html#ad8cf2bb4a79b9d63ac8c6b2316a5224a">mergeList</a></td></tr>
<tr class="separator:ad8cf2bb4a79b9d63ac8c6b2316a5224a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a5d368288029b349845d226e059b9d8dc"><td class="memItemLeft" align="right" valign="top">GSList *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structQofBookMergeData.html#a5d368288029b349845d226e059b9d8dc">targetList</a></td></tr>
<tr class="separator:a5d368288029b349845d226e059b9d8dc"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8149ebfe7b7832e2aa6ec268860b8630"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Book.html#gaac9e9590fcc4c8a312dcd6b0846a9157">QofBook</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structQofBookMergeData.html#a8149ebfe7b7832e2aa6ec268860b8630">mergeBook</a></td></tr>
<tr class="separator:a8149ebfe7b7832e2aa6ec268860b8630"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac093ce2eb6166b9625afce16a7931450"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group__Book.html#gaac9e9590fcc4c8a312dcd6b0846a9157">QofBook</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structQofBookMergeData.html#ac093ce2eb6166b9625afce16a7931450">targetBook</a></td></tr>
<tr class="separator:ac093ce2eb6166b9625afce16a7931450"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a3af6b7afad9da3a486a8d5970beeaa3b"><td class="memItemLeft" align="right" valign="top">gboolean&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structQofBookMergeData.html#a3af6b7afad9da3a486a8d5970beeaa3b">abort</a></td></tr>
<tr class="separator:a3af6b7afad9da3a486a8d5970beeaa3b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8a06826e613df1c38774af6b39346dc5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="structQofBookMergeRule.html">QofBookMergeRule</a> *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structQofBookMergeData.html#a8a06826e613df1c38774af6b39346dc5">currentRule</a></td></tr>
<tr class="separator:a8a06826e613df1c38774af6b39346dc5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1ce3ba91da8ddfaa5625682f7494aca5"><td class="memItemLeft" align="right" valign="top">GSList *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structQofBookMergeData.html#a1ce3ba91da8ddfaa5625682f7494aca5">orphan_list</a></td></tr>
<tr class="separator:a1ce3ba91da8ddfaa5625682f7494aca5"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af1b7cbdc992082b846dfb0e906aee181"><td class="memItemLeft" align="right" valign="top">GHashTable *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structQofBookMergeData.html#af1b7cbdc992082b846dfb0e906aee181">target_table</a></td></tr>
<tr class="separator:af1b7cbdc992082b846dfb0e906aee181"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>mergeData contains the essential context data for any merge. </p>
<p>Used to dictate what to merge, how to merge it, where to get the new data and where to put the amended data.</p>
<p>Combines lists of <em>::QofParam</em>, <em><a class="el" href="group__Entity.html#ga18f304841a8fd7e75db9af738c589ad2">QofEntity</a></em> and <em><a class="el" href="structQofBookMergeRule.html" title="One rule per entity, built into a single GList for the entire merge. ">QofBookMergeRule</a></em> into one struct that can be easily passed between callbacks. Also holds the pointers to the import and target <a class="el" href="group__Book.html#gaac9e9590fcc4c8a312dcd6b0846a9157" title="QofBook reference. ">QofBook</a> structures.</p>
<ul>
<li>targetList and mergeObjectParams change each time a new object type is set for compare.</li>
<li>mergeList is the complete list of rules for all objects in the import book. </li>
</ul>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00209">209</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a3af6b7afad9da3a486a8d5970beeaa3b"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">gboolean QofBookMergeData::abort</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>set to TRUE if MERGE_INVALID is set. </p>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00221">221</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>

</div>
</div>
<a class="anchor" id="a8a06826e613df1c38774af6b39346dc5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="structQofBookMergeRule.html">QofBookMergeRule</a>* QofBookMergeData::currentRule</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>placeholder for the rule currently being tested or applied. </p>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00222">222</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>

</div>
</div>
<a class="anchor" id="a8149ebfe7b7832e2aa6ec268860b8630"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Book.html#gaac9e9590fcc4c8a312dcd6b0846a9157">QofBook</a>* QofBookMergeData::mergeBook</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to the import book for this merge operation. </p>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00217">217</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>

</div>
</div>
<a class="anchor" id="ad8cf2bb4a79b9d63ac8c6b2316a5224a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GList* QofBookMergeData::mergeList</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>GList of all ::qof_book_mergeRule rules for the merge operation. </p>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00213">213</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>

</div>
</div>
<a class="anchor" id="ae8b811aac4ad4d05ca3a16dc6587814a"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GSList* QofBookMergeData::mergeObjectParams</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>GSList of ::QofParam details for each parameter in the current object. </p>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00211">211</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>

</div>
</div>
<a class="anchor" id="a1ce3ba91da8ddfaa5625682f7494aca5"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GSList* QofBookMergeData::orphan_list</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>List of QofEntity's that need to be rematched.</p>
<p>When one QofEntity has a lower difference to the targetEnt than the previous best_match, the new match takes precedence. This list holds those orphaned entities that are not a good enough match so that these can be rematched later. The ranking is handled using the private QofEntityRating struct and the GHashTable <a class="el" href="structQofBookMergeData.html#af1b7cbdc992082b846dfb0e906aee181">QofBookMergeData::target_table</a>. </p>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00224">224</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>

</div>
</div>
<a class="anchor" id="af1b7cbdc992082b846dfb0e906aee181"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GHashTable* QofBookMergeData::target_table</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>The GHashTable to hold the QofEntityRating values. </p>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00232">232</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>

</div>
</div>
<a class="anchor" id="ac093ce2eb6166b9625afce16a7931450"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname"><a class="el" href="group__Book.html#gaac9e9590fcc4c8a312dcd6b0846a9157">QofBook</a>* QofBookMergeData::targetBook</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>pointer to the target book for this merge operation. </p>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00219">219</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>

</div>
</div>
<a class="anchor" id="a5d368288029b349845d226e059b9d8dc"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">GSList* QofBookMergeData::targetList</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>GSList of <a class="el" href="group__Entity.html#ga18f304841a8fd7e75db9af738c589ad2">QofEntity</a> * for each object of this type in the target book </p>

<p>Definition at line <a class="el" href="qofbookmerge_8h_source.html#l00215">215</a> of file <a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="qofbookmerge_8h_source.html">qofbookmerge.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Feb 5 2014 01:35:07 for QOF by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.6
</small></address>
</body>
</html>