File: structmskwajd__header.html

package info (click to toggle)
libmspack 0.5-1
  • links: PTS, VCS
  • area: main
  • in suites: jessie-kfreebsd
  • size: 3,916 kB
  • sloc: sh: 11,332; ansic: 7,879; perl: 131; makefile: 97
file content (233 lines) | stat: -rw-r--r-- 13,422 bytes parent folder | download | duplicates (3)
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
<!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>libmspack: mskwajd_header 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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
  $(document).ready(function() { searchBox.OnSelectItem(0); });
</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">libmspack
   </div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.6 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Main&#160;Page</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>
      <li>
        <div id="MSearchBox" class="MSearchBoxInactive">
        <span class="left">
          <img id="MSearchSelect" src="search/mag_sel.png"
               onmouseover="return searchBox.OnSearchSelectShow()"
               onmouseout="return searchBox.OnSearchSelectHide()"
               alt=""/>
          <input type="text" id="MSearchField" value="Search" accesskey="S"
               onfocus="searchBox.OnSearchFieldFocus(true)" 
               onblur="searchBox.OnSearchFieldFocus(false)" 
               onkeyup="searchBox.OnSearchFieldChange(event)"/>
          </span><span class="right">
            <a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
          </span>
        </div>
      </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>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark">&#160;</span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark">&#160;</span>Data Structures</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark">&#160;</span>Files</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark">&#160;</span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark">&#160;</span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark">&#160;</span>Macros</a></div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Data Fields</a>  </div>
  <div class="headertitle">
<div class="title">mskwajd_header Struct Reference</div>  </div>
</div><!--header-->
<div class="contents">

<p>A structure which represents an KWAJ compressed file.  
 <a href="structmskwajd__header.html#details">More...</a></p>

<p><code>#include &lt;<a class="el" href="mspack_8h_source.html">mspack.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:a3e715be39a9022552f730948d13085ab"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a3e715be39a9022552f730948d13085ab">comp_type</a></td></tr>
<tr class="memdesc:a3e715be39a9022552f730948d13085ab"><td class="mdescLeft">&#160;</td><td class="mdescRight">The compression type; should be one of <a class="el" href="mspack_8h.html#a7a422bbe045d6c4d2137432ccaa87287" title="KWAJ compression type: no compression. ">MSKWAJ_COMP_NONE</a>, <a class="el" href="mspack_8h.html#a1921fcc0b096f13ee40eb78328f8e1c9" title="KWAJ compression type: no compression, 0xFF XOR &quot;encryption&quot;. ">MSKWAJ_COMP_XOR</a>, <a class="el" href="mspack_8h.html#a10b39d2b4edb12e70d92ede3b2290cf7" title="KWAJ compression type: LZSS (same method as SZDD) ">MSKWAJ_COMP_SZDD</a> or <a class="el" href="mspack_8h.html#af61a7a99713aab5cbb64bc0d58189e02" title="KWAJ compression type: LZ+Huffman compression. ">MSKWAJ_COMP_LZH</a>.  <a href="#a3e715be39a9022552f730948d13085ab">More...</a><br/></td></tr>
<tr class="separator:a3e715be39a9022552f730948d13085ab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ace36762bb483edb0f8365b6463708d72"><td class="memItemLeft" align="right" valign="top">off_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#ace36762bb483edb0f8365b6463708d72">data_offset</a></td></tr>
<tr class="memdesc:ace36762bb483edb0f8365b6463708d72"><td class="mdescLeft">&#160;</td><td class="mdescRight">The offset in the file where the compressed data stream begins.  <a href="#ace36762bb483edb0f8365b6463708d72">More...</a><br/></td></tr>
<tr class="separator:ace36762bb483edb0f8365b6463708d72"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a62b3852fcc90781f98a1017b32679fab"><td class="memItemLeft" align="right" valign="top">int&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a62b3852fcc90781f98a1017b32679fab">headers</a></td></tr>
<tr class="memdesc:a62b3852fcc90781f98a1017b32679fab"><td class="mdescLeft">&#160;</td><td class="mdescRight">Flags indicating which optional headers were included.  <a href="#a62b3852fcc90781f98a1017b32679fab">More...</a><br/></td></tr>
<tr class="separator:a62b3852fcc90781f98a1017b32679fab"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:afac7807b7f2ae032cd765ec7b875fef1"><td class="memItemLeft" align="right" valign="top">off_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#afac7807b7f2ae032cd765ec7b875fef1">length</a></td></tr>
<tr class="memdesc:afac7807b7f2ae032cd765ec7b875fef1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The amount of uncompressed data in the file, or 0 if not present.  <a href="#afac7807b7f2ae032cd765ec7b875fef1">More...</a><br/></td></tr>
<tr class="separator:afac7807b7f2ae032cd765ec7b875fef1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1f6bdf2cdb6bf2425327eb3c8a480564"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a1f6bdf2cdb6bf2425327eb3c8a480564">filename</a></td></tr>
<tr class="memdesc:a1f6bdf2cdb6bf2425327eb3c8a480564"><td class="mdescLeft">&#160;</td><td class="mdescRight">output filename, or NULL if not present  <a href="#a1f6bdf2cdb6bf2425327eb3c8a480564">More...</a><br/></td></tr>
<tr class="separator:a1f6bdf2cdb6bf2425327eb3c8a480564"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a67205e9e87199ec6ce1e1d6569cd077c"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a67205e9e87199ec6ce1e1d6569cd077c">extra</a></td></tr>
<tr class="memdesc:a67205e9e87199ec6ce1e1d6569cd077c"><td class="mdescLeft">&#160;</td><td class="mdescRight">extra uncompressed data (usually text) in the header.  <a href="#a67205e9e87199ec6ce1e1d6569cd077c">More...</a><br/></td></tr>
<tr class="separator:a67205e9e87199ec6ce1e1d6569cd077c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a150dd01507ddef57a4d77c5f4f9914fa"><td class="memItemLeft" align="right" valign="top">unsigned short&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structmskwajd__header.html#a150dd01507ddef57a4d77c5f4f9914fa">extra_length</a></td></tr>
<tr class="memdesc:a150dd01507ddef57a4d77c5f4f9914fa"><td class="mdescLeft">&#160;</td><td class="mdescRight">length of extra uncompressed data in the header  <a href="#a150dd01507ddef57a4d77c5f4f9914fa">More...</a><br/></td></tr>
<tr class="separator:a150dd01507ddef57a4d77c5f4f9914fa"><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>A structure which represents an KWAJ compressed file. </p>
<p>All fields are READ ONLY. </p>
</div><h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a3e715be39a9022552f730948d13085ab"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned short mskwajd_header::comp_type</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The compression type; should be one of <a class="el" href="mspack_8h.html#a7a422bbe045d6c4d2137432ccaa87287" title="KWAJ compression type: no compression. ">MSKWAJ_COMP_NONE</a>, <a class="el" href="mspack_8h.html#a1921fcc0b096f13ee40eb78328f8e1c9" title="KWAJ compression type: no compression, 0xFF XOR &quot;encryption&quot;. ">MSKWAJ_COMP_XOR</a>, <a class="el" href="mspack_8h.html#a10b39d2b4edb12e70d92ede3b2290cf7" title="KWAJ compression type: LZSS (same method as SZDD) ">MSKWAJ_COMP_SZDD</a> or <a class="el" href="mspack_8h.html#af61a7a99713aab5cbb64bc0d58189e02" title="KWAJ compression type: LZ+Huffman compression. ">MSKWAJ_COMP_LZH</a>. </p>

</div>
</div>
<a class="anchor" id="ace36762bb483edb0f8365b6463708d72"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">off_t mskwajd_header::data_offset</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The offset in the file where the compressed data stream begins. </p>

</div>
</div>
<a class="anchor" id="a67205e9e87199ec6ce1e1d6569cd077c"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* mskwajd_header::extra</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>extra uncompressed data (usually text) in the header. </p>
<p>This data can contain nulls so use extra_length to get the size. </p>

</div>
</div>
<a class="anchor" id="a150dd01507ddef57a4d77c5f4f9914fa"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">unsigned short mskwajd_header::extra_length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>length of extra uncompressed data in the header </p>

</div>
</div>
<a class="anchor" id="a1f6bdf2cdb6bf2425327eb3c8a480564"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">char* mskwajd_header::filename</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>output filename, or NULL if not present </p>

</div>
</div>
<a class="anchor" id="a62b3852fcc90781f98a1017b32679fab"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">int mskwajd_header::headers</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Flags indicating which optional headers were included. </p>

</div>
</div>
<a class="anchor" id="afac7807b7f2ae032cd765ec7b875fef1"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">off_t mskwajd_header::length</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>The amount of uncompressed data in the file, or 0 if not present. </p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="mspack_8h_source.html">mspack.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated 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>