/usr/share/GNUstep/Documentation/Performance/GSLinkedList.html is in libperformance-dev 0.5.0-1.
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 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>GSLinkedList documentation</title>
</head>
<body>
<font face="serif">
<h1><a name="title$GSLinkedList">GSLinkedList documentation</a></h1>
<h3>Authors</h3>
<dl>
<dt>Richard Frith-Macdonald (<a href="mailto:rfm@gnu.org"><code>rfm@gnu.org</code></a>)</dt>
<dd>
</dd>
</dl>
<p><b>Copyright:</b> (C) 2010 Free Software Foundation, Inc.</p>
<div>
<hr width="50%" align="left" />
<h3>Contents -</h3>
<ol>
<li>
<a href="#001000000000">Software documentation for the GSLinkedList class</a>
</li>
<li>
<a href="#002000000000">Software documentation for the GSListLink class</a>
</li>
<li>
<a href="#003000000000">GSLinkedList types</a>
</li>
<li>
<a href="#004000000000">GSLinkedList functions</a>
</li>
</ol>
<hr width="50%" align="left" />
</div>
<h1><a name="001000000000">
Software documentation for the GSLinkedList class
</a></h1>
<h2><a name="class$GSLinkedList">GSLinkedList</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GSLinkedList.h</dd>
</dl>
</blockquote>
<div class="desc">
GSLinkedList manages a list of GSListLink
objects.
</div>
<hr width="50%" align="left" />
<a href="#_GSLinkedList_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-append$">-append:</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-count">-count</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-empty">-empty</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-findEqual$from$back$">-findEqual:from:back:</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-findIdentical$from$back$">-findIdentical:from:back:</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-head">-head</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-insert$after$">-insert:after:</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-insert$before$">-insert:before:</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-removeLink$">-removeLink:</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSLinkedList-tail">-tail</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSLinkedList-append$">append: </a></h3>
- (void) <b>append:</b> (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*)link;<br />
<div class="desc">
Appends <var>link</var> at the end of the linked
list managed by the receiver. <br /> Retains the
<var>link</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSLinkedList-count">count </a></h3>
- (<a rel="gsdoc" href="#type$NSUInteger">NSUInteger</a>) <b>count</b>;<br />
<div class="desc">
Returns the number of links in the list.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSLinkedList-empty">empty </a></h3>
- (void) <b>empty</b>;<br />
<div class="desc">
Remove all links from the list and release them all.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSLinkedList-findEqual$from$back$">findEqual: from: back: </a></h3>
- (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*) <b>findEqual:</b> (NSObject*)object<b> from:</b> (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*)start<b> back:</b> (BOOL)aFlag;<br />
<div class="desc">
Searches the linked list returning the link
containing <var>object</var> or <code>nil</code>
if it is not found. <br /> The comparison is performed
using the
[NSObject -isEqual:]
method of <var>object</var>. <br /> If
<var>start</var> is <code>nil</code> then the whole
list is searched. <br /> This method will <em>not</em>
find links containing <code>nil</code> items.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSLinkedList-findIdentical$from$back$">findIdentical: from: back: </a></h3>
- (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*) <b>findIdentical:</b> (NSObject*)object<b> from:</b> (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*)start<b> back:</b> (BOOL)aFlag;<br />
<div class="desc">
Searches the linked list returning the link
containing <var>object</var> or <code>nil</code>
if it is not found. <br /> If <var>start</var> is
<code>nil</code> then the whole list is searched.
<br /> A direct pointer comparison is used to
determine equality.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSLinkedList-head">head </a></h3>
- (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*) <b>head</b>;<br />
<div class="desc">
Returns the first link in the list.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSLinkedList-insert$after$">insert: after: </a></h3>
- (void) <b>insert:</b> (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*)link<b> after:</b> (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*)at;<br />
<div class="desc">
Inserts other immediately after the receiver.
<br /> Retains the <var>link</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSLinkedList-insert$before$">insert: before: </a></h3>
- (void) <b>insert:</b> (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*)link<b> before:</b> (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*)at;<br />
<div class="desc">
Inserts other immediately before the receiver.
<br /> Retains the <var>link</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSLinkedList-removeLink$">removeLink: </a></h3>
- (void) <b>removeLink:</b> (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*)link;<br />
<div class="desc">
Removes the <var>link</var> from the receiver.
<br /> releases the <var>link</var>.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSLinkedList-tail">tail </a></h3>
- (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*) <b>tail</b>;<br />
<div class="desc">
Returns the last link in the list.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSLinkedList_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSLinkedList Class</h2>
<h3><a name="ivariable$GSLinkedList*count">count</a></h3>
@public NSUInteger <b>count</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSLinkedList*head">head</a></h3>
@public GSListLink* <b>head</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSLinkedList*tail">tail</a></h3>
@public GSListLink* <b>tail</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="002000000000">
Software documentation for the GSListLink class
</a></h1>
<h2><a name="class$GSListLink">GSListLink</a> : NSObject</h2>
<blockquote class="declared">
<dl>
<dt><b>Declared in:</b></dt>
<dd>GSLinkedList.h</dd>
</dl>
</blockquote>
<div class="desc">
GSListLink provides simple doubly linked list
functionality to avoid the need to constantly
re-invent it (as the OpenStep/Cocoa APIs do not
provide this). The emphasis is on speed of operation
so instance variables are directly accessible and inline
functions are provided to manipulate them (without
error cehcking), but you can/should avoid these direct
access features unless speed is really critical.
<br /> A list may either be 'normal'... (where the
head/tail ends of the list have a <code>nil</code>
pointer to the previous/next link) or 'circular' in
which case the list is not terminated. <br /> The
GSListLink item carries a minimal payload of a
single item which is retained by the link. <br /> The
GSListLink owner is an optional pointer to an
object which 'owns' the link... a GSLinkedList
instance may use this to check link ownership when
manipulating links.
</div>
<hr width="50%" align="left" />
<a href="#_GSListLink_ivars">Instance Variables</a>
<br/><br/>
<b>Method summary</b>
<ul>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSListLink-initCircular">-initCircular</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSListLink-item">-item</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSListLink-next">-next</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSListLink-owner">-owner</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSListLink-previous">-previous</a></li>
<li><a rel="gsdoc" href="GSLinkedList.html#method$GSListLink-setItem$">-setItem:</a></li>
</ul>
<hr width="50%" align="left" />
<div class="method">
<h3><a name="method$GSListLink-initCircular">initCircular </a></h3>
- (id) <b>initCircular</b>;<br />
<div class="desc">
Initialise the receiver as a link for a circular
linked list.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSListLink-item">item </a></h3>
- (NSObject*) <b>item</b>;<br />
<div class="desc">
Return the item in the link.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSListLink-next">next </a></h3>
- (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*) <b>next</b>;<br />
<div class="desc">
Return the next item in the list containing the
receiver, or <code>nil</code> if there are no
more items.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSListLink-owner">owner </a></h3>
- (<a rel="gsdoc" href="#class$GSLinkedList">GSLinkedList</a>*) <b>owner</b>;<br />
<div class="desc">
Return the list which owns the receiver or
<code>nil</code> if the receiver is not in a list.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSListLink-previous">previous </a></h3>
- (<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>*) <b>previous</b>;<br />
<div class="desc">
Return the previous item in the list containing the
receiver, or <code>nil</code> if there are no
more items.
</div>
<hr width="25%" align="left" />
</div>
<div class="method">
<h3><a name="method$GSListLink-setItem$">setItem: </a></h3>
- (void) <b>setItem:</b> (NSObject*)anItem;<br />
<div class="desc">
Set an item value by retaining it and releasing any
previous value.
</div>
<hr width="25%" align="left" />
</div>
<a name="_GSListLink_ivars"/> <br/><hr width="50%" align="left" />
<h2>Instance Variables for GSListLink Class</h2>
<h3><a name="ivariable$GSListLink*item">item</a></h3>
@public NSObject* <b>item</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSListLink*next">next</a></h3>
@public GSListLink* <b>next</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSListLink*owner">owner</a></h3>
@public GSLinkedList* <b>owner</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h3><a name="ivariable$GSListLink*previous">previous</a></h3>
@public GSListLink* <b>previous</b>;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<br/><hr width="50%" align="left" /><br/>
<h1><a name="003000000000">GSLinkedList types</a></h1>
<p>
</p>
<h3><a name="type$NSUInteger">NSUInteger</a></h3>
typedef unsigned int NSUInteger;<br />
<div class="desc">
<em>Description forthcoming.</em>
</div>
<hr width="25%" align="left" />
<h1><a name="004000000000">GSLinkedList functions</a></h1>
<p>
</p>
<h3><a name="function$GSLinkCircularInsertAfter">GSLinkCircularInsertAfter</a></h3>
void GSLinkCircularInsertAfter(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>, <a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>at</b>);<br />
<div class="desc">
Inserts <var>link</var> after <var>at</var> in a
circular list. <br /> Arguments must not be
<code>nil</code> and <var>link</var> must not be in a
list (ie its next and previous pointers must point to
itsself).
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkCircularInsertBefore">GSLinkCircularInsertBefore</a></h3>
void GSLinkCircularInsertBefore(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>, <a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>at</b>);<br />
<div class="desc">
Inserts <var>link</var> before <var>at</var> in a
circular list. <br /> Arguments must not be
<code>nil</code> and <var>link</var> must not be in a
list (ie its next and previous pointers must point to
itsself).
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkCircularRemove">GSLinkCircularRemove</a></h3>
void GSLinkCircularRemove(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>);<br />
<div class="desc">
Removes <var>link</var> from any list it is in.
<br /> The <var>link</var> argument must not be
<code>nil</code>.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkInsertAfter">GSLinkInsertAfter</a></h3>
void GSLinkInsertAfter(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>, <a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>at</b>);<br />
<div class="desc">
Inserts <var>link</var> after <var>at</var> in a
normal list. <br /> Arguments must not be
<code>nil</code> and <var>link</var> must not be in a
list (ie its next and previous pointers must both be
<code>nil</code>).
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkInsertBefore">GSLinkInsertBefore</a></h3>
void GSLinkInsertBefore(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>, <a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>at</b>);<br />
<div class="desc">
Inserts <var>link</var> before <var>at</var> in a
normal list. <br /> Arguments must not be
<code>nil</code> and <var>link</var> must not be in a
list (ie its next and previous pointers must both be
<code>nil</code>).
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkRemove">GSLinkRemove</a></h3>
void GSLinkRemove(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>);<br />
<div class="desc">
Removes <var>link</var> from the list it is in.
<br /> The <var>link</var> argument must not be
<code>nil</code>.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkedListFindEqual">GSLinkedListFindEqual</a></h3>
<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* GSLinkedListFindEqual(NSObject* <b>object</b>, <a rel="gsdoc" href="#class$GSLinkedList">GSLinkedList</a>* <b>list</b>, <a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>from</b>, BOOL <b>back</b>);<br />
<div class="desc">
Searches <var>from</var> <var>list</var> to the end
looking for the first link containing
<var>object</var> (as determined by using object's
[NSObject -isEqual:]
method). <br /> If <var>from</var> is
<code>nil</code> the <var>list</var> is search
<var>from</var> head or tail as appropriate to the
direction in which it is searched.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkedListFindIdentical">GSLinkedListFindIdentical</a></h3>
<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* GSLinkedListFindIdentical(NSObject* <b>object</b>, <a rel="gsdoc" href="#class$GSLinkedList">GSLinkedList</a>* <b>list</b>, <a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>from</b>, BOOL <b>back</b>);<br />
<div class="desc">
Searches <var>from</var> <var>list</var> to the end
looking for the first link containing
<var>object</var> (as determined by direct pointer
comparison). <br /> If <var>from</var> is
<code>nil</code> the <var>list</var> is search
<var>from</var> head or tail as appropriate to the
direction in which it is searched.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkedListInsertAfter">GSLinkedListInsertAfter</a></h3>
void GSLinkedListInsertAfter(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>, <a rel="gsdoc" href="#class$GSLinkedList">GSLinkedList</a>* <b>list</b>, <a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>at</b>);<br />
<div class="desc">
Inserts <var>link</var> immediately after
<var>at</var>. <br /> Updates the head, tail and count
variables of <var>list</var>. <br /> Does not
retain <var>link</var>.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkedListInsertBefore">GSLinkedListInsertBefore</a></h3>
void GSLinkedListInsertBefore(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>, <a rel="gsdoc" href="#class$GSLinkedList">GSLinkedList</a>* <b>list</b>, <a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>at</b>);<br />
<div class="desc">
Inserts <var>link</var> immediately before
<var>at</var>. <br /> Updates the head, tail and count
variables of <var>list</var>. <br /> Does not
retain <var>link</var>.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkedListMoveToHead">GSLinkedListMoveToHead</a></h3>
void GSLinkedListMoveToHead(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>, <a rel="gsdoc" href="#class$GSLinkedList">GSLinkedList</a>* <b>list</b>);<br />
<div class="desc">
Moves the <var>link</var> to the head of the
<var>list</var> if it is not already there.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkedListMoveToTail">GSLinkedListMoveToTail</a></h3>
void GSLinkedListMoveToTail(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>, <a rel="gsdoc" href="#class$GSLinkedList">GSLinkedList</a>* <b>list</b>);<br />
<div class="desc">
Moves the <var>link</var> to the tail of the
<var>list</var> if it is not already there.
</div>
<hr width="25%" align="left" />
<h3><a name="function$GSLinkedListRemove">GSLinkedListRemove</a></h3>
void GSLinkedListRemove(<a rel="gsdoc" href="#class$GSListLink">GSListLink</a>* <b>link</b>, <a rel="gsdoc" href="#class$GSLinkedList">GSLinkedList</a>* <b>list</b>);<br />
<div class="desc">
Removes <var>link</var> from the <var>list</var>.
<br /> Updates the head, tail and count variables of
<var>list</var>. <br /> Does not release
<var>link</var>.
</div>
<hr width="25%" align="left" />
<br />
</font>
</body>
</html>
|