├── .travis.yml
├── LICENSE
├── README.org
├── list.c
├── list.h
└── test_list.c
/.travis.yml:
--------------------------------------------------------------------------------
1 | language: c
2 | sudo: false
3 | compiler:
4 | - clang
5 | - gcc
6 | script:
7 | - git clone https://github.com/andschwa/c-unit-test.git test
8 | - gcc -O -Wall -Werror -std=gnu99 -DTEST_DEBUG -DLIST_DEBUG -o test_list list.c test_list.c test/test.c
9 | - ./test_list
10 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU AFFERO GENERAL PUBLIC LICENSE
2 | Version 3, 19 November 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
5 | Everyone is permitted to copy and distribute verbatim copies
6 | of this license document, but changing it is not allowed.
7 |
8 | Preamble
9 |
10 | The GNU Affero General Public License is a free, copyleft license for
11 | software and other kinds of works, specifically designed to ensure
12 | cooperation with the community in the case of network server software.
13 |
14 | The licenses for most software and other practical works are designed
15 | to take away your freedom to share and change the works. By contrast,
16 | our General Public Licenses are intended to guarantee your freedom to
17 | share and change all versions of a program--to make sure it remains free
18 | software for all its users.
19 |
20 | When we speak of free software, we are referring to freedom, not
21 | price. Our General Public Licenses are designed to make sure that you
22 | have the freedom to distribute copies of free software (and charge for
23 | them if you wish), that you receive source code or can get it if you
24 | want it, that you can change the software or use pieces of it in new
25 | free programs, and that you know you can do these things.
26 |
27 | Developers that use our General Public Licenses protect your rights
28 | with two steps: (1) assert copyright on the software, and (2) offer
29 | you this License which gives you legal permission to copy, distribute
30 | and/or modify the software.
31 |
32 | A secondary benefit of defending all users' freedom is that
33 | improvements made in alternate versions of the program, if they
34 | receive widespread use, become available for other developers to
35 | incorporate. Many developers of free software are heartened and
36 | encouraged by the resulting cooperation. However, in the case of
37 | software used on network servers, this result may fail to come about.
38 | The GNU General Public License permits making a modified version and
39 | letting the public access it on a server without ever releasing its
40 | source code to the public.
41 |
42 | The GNU Affero General Public License is designed specifically to
43 | ensure that, in such cases, the modified source code becomes available
44 | to the community. It requires the operator of a network server to
45 | provide the source code of the modified version running there to the
46 | users of that server. Therefore, public use of a modified version, on
47 | a publicly accessible server, gives the public access to the source
48 | code of the modified version.
49 |
50 | An older license, called the Affero General Public License and
51 | published by Affero, was designed to accomplish similar goals. This is
52 | a different license, not a version of the Affero GPL, but Affero has
53 | released a new version of the Affero GPL which permits relicensing under
54 | this license.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | TERMS AND CONDITIONS
60 |
61 | 0. Definitions.
62 |
63 | "This License" refers to version 3 of the GNU Affero General Public License.
64 |
65 | "Copyright" also means copyright-like laws that apply to other kinds of
66 | works, such as semiconductor masks.
67 |
68 | "The Program" refers to any copyrightable work licensed under this
69 | License. Each licensee is addressed as "you". "Licensees" and
70 | "recipients" may be individuals or organizations.
71 |
72 | To "modify" a work means to copy from or adapt all or part of the work
73 | in a fashion requiring copyright permission, other than the making of an
74 | exact copy. The resulting work is called a "modified version" of the
75 | earlier work or a work "based on" the earlier work.
76 |
77 | A "covered work" means either the unmodified Program or a work based
78 | on the Program.
79 |
80 | To "propagate" a work means to do anything with it that, without
81 | permission, would make you directly or secondarily liable for
82 | infringement under applicable copyright law, except executing it on a
83 | computer or modifying a private copy. Propagation includes copying,
84 | distribution (with or without modification), making available to the
85 | public, and in some countries other activities as well.
86 |
87 | To "convey" a work means any kind of propagation that enables other
88 | parties to make or receive copies. Mere interaction with a user through
89 | a computer network, with no transfer of a copy, is not conveying.
90 |
91 | An interactive user interface displays "Appropriate Legal Notices"
92 | to the extent that it includes a convenient and prominently visible
93 | feature that (1) displays an appropriate copyright notice, and (2)
94 | tells the user that there is no warranty for the work (except to the
95 | extent that warranties are provided), that licensees may convey the
96 | work under this License, and how to view a copy of this License. If
97 | the interface presents a list of user commands or options, such as a
98 | menu, a prominent item in the list meets this criterion.
99 |
100 | 1. Source Code.
101 |
102 | The "source code" for a work means the preferred form of the work
103 | for making modifications to it. "Object code" means any non-source
104 | form of a work.
105 |
106 | A "Standard Interface" means an interface that either is an official
107 | standard defined by a recognized standards body, or, in the case of
108 | interfaces specified for a particular programming language, one that
109 | is widely used among developers working in that language.
110 |
111 | The "System Libraries" of an executable work include anything, other
112 | than the work as a whole, that (a) is included in the normal form of
113 | packaging a Major Component, but which is not part of that Major
114 | Component, and (b) serves only to enable use of the work with that
115 | Major Component, or to implement a Standard Interface for which an
116 | implementation is available to the public in source code form. A
117 | "Major Component", in this context, means a major essential component
118 | (kernel, window system, and so on) of the specific operating system
119 | (if any) on which the executable work runs, or a compiler used to
120 | produce the work, or an object code interpreter used to run it.
121 |
122 | The "Corresponding Source" for a work in object code form means all
123 | the source code needed to generate, install, and (for an executable
124 | work) run the object code and to modify the work, including scripts to
125 | control those activities. However, it does not include the work's
126 | System Libraries, or general-purpose tools or generally available free
127 | programs which are used unmodified in performing those activities but
128 | which are not part of the work. For example, Corresponding Source
129 | includes interface definition files associated with source files for
130 | the work, and the source code for shared libraries and dynamically
131 | linked subprograms that the work is specifically designed to require,
132 | such as by intimate data communication or control flow between those
133 | subprograms and other parts of the work.
134 |
135 | The Corresponding Source need not include anything that users
136 | can regenerate automatically from other parts of the Corresponding
137 | Source.
138 |
139 | The Corresponding Source for a work in source code form is that
140 | same work.
141 |
142 | 2. Basic Permissions.
143 |
144 | All rights granted under this License are granted for the term of
145 | copyright on the Program, and are irrevocable provided the stated
146 | conditions are met. This License explicitly affirms your unlimited
147 | permission to run the unmodified Program. The output from running a
148 | covered work is covered by this License only if the output, given its
149 | content, constitutes a covered work. This License acknowledges your
150 | rights of fair use or other equivalent, as provided by copyright law.
151 |
152 | You may make, run and propagate covered works that you do not
153 | convey, without conditions so long as your license otherwise remains
154 | in force. You may convey covered works to others for the sole purpose
155 | of having them make modifications exclusively for you, or provide you
156 | with facilities for running those works, provided that you comply with
157 | the terms of this License in conveying all material for which you do
158 | not control copyright. Those thus making or running the covered works
159 | for you must do so exclusively on your behalf, under your direction
160 | and control, on terms that prohibit them from making any copies of
161 | your copyrighted material outside their relationship with you.
162 |
163 | Conveying under any other circumstances is permitted solely under
164 | the conditions stated below. Sublicensing is not allowed; section 10
165 | makes it unnecessary.
166 |
167 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law.
168 |
169 | No covered work shall be deemed part of an effective technological
170 | measure under any applicable law fulfilling obligations under article
171 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or
172 | similar laws prohibiting or restricting circumvention of such
173 | measures.
174 |
175 | When you convey a covered work, you waive any legal power to forbid
176 | circumvention of technological measures to the extent such circumvention
177 | is effected by exercising rights under this License with respect to
178 | the covered work, and you disclaim any intention to limit operation or
179 | modification of the work as a means of enforcing, against the work's
180 | users, your or third parties' legal rights to forbid circumvention of
181 | technological measures.
182 |
183 | 4. Conveying Verbatim Copies.
184 |
185 | You may convey verbatim copies of the Program's source code as you
186 | receive it, in any medium, provided that you conspicuously and
187 | appropriately publish on each copy an appropriate copyright notice;
188 | keep intact all notices stating that this License and any
189 | non-permissive terms added in accord with section 7 apply to the code;
190 | keep intact all notices of the absence of any warranty; and give all
191 | recipients a copy of this License along with the Program.
192 |
193 | You may charge any price or no price for each copy that you convey,
194 | and you may offer support or warranty protection for a fee.
195 |
196 | 5. Conveying Modified Source Versions.
197 |
198 | You may convey a work based on the Program, or the modifications to
199 | produce it from the Program, in the form of source code under the
200 | terms of section 4, provided that you also meet all of these conditions:
201 |
202 | a) The work must carry prominent notices stating that you modified
203 | it, and giving a relevant date.
204 |
205 | b) The work must carry prominent notices stating that it is
206 | released under this License and any conditions added under section
207 | 7. This requirement modifies the requirement in section 4 to
208 | "keep intact all notices".
209 |
210 | c) You must license the entire work, as a whole, under this
211 | License to anyone who comes into possession of a copy. This
212 | License will therefore apply, along with any applicable section 7
213 | additional terms, to the whole of the work, and all its parts,
214 | regardless of how they are packaged. This License gives no
215 | permission to license the work in any other way, but it does not
216 | invalidate such permission if you have separately received it.
217 |
218 | d) If the work has interactive user interfaces, each must display
219 | Appropriate Legal Notices; however, if the Program has interactive
220 | interfaces that do not display Appropriate Legal Notices, your
221 | work need not make them do so.
222 |
223 | A compilation of a covered work with other separate and independent
224 | works, which are not by their nature extensions of the covered work,
225 | and which are not combined with it such as to form a larger program,
226 | in or on a volume of a storage or distribution medium, is called an
227 | "aggregate" if the compilation and its resulting copyright are not
228 | used to limit the access or legal rights of the compilation's users
229 | beyond what the individual works permit. Inclusion of a covered work
230 | in an aggregate does not cause this License to apply to the other
231 | parts of the aggregate.
232 |
233 | 6. Conveying Non-Source Forms.
234 |
235 | You may convey a covered work in object code form under the terms
236 | of sections 4 and 5, provided that you also convey the
237 | machine-readable Corresponding Source under the terms of this License,
238 | in one of these ways:
239 |
240 | a) Convey the object code in, or embodied in, a physical product
241 | (including a physical distribution medium), accompanied by the
242 | Corresponding Source fixed on a durable physical medium
243 | customarily used for software interchange.
244 |
245 | b) Convey the object code in, or embodied in, a physical product
246 | (including a physical distribution medium), accompanied by a
247 | written offer, valid for at least three years and valid for as
248 | long as you offer spare parts or customer support for that product
249 | model, to give anyone who possesses the object code either (1) a
250 | copy of the Corresponding Source for all the software in the
251 | product that is covered by this License, on a durable physical
252 | medium customarily used for software interchange, for a price no
253 | more than your reasonable cost of physically performing this
254 | conveying of source, or (2) access to copy the
255 | Corresponding Source from a network server at no charge.
256 |
257 | c) Convey individual copies of the object code with a copy of the
258 | written offer to provide the Corresponding Source. This
259 | alternative is allowed only occasionally and noncommercially, and
260 | only if you received the object code with such an offer, in accord
261 | with subsection 6b.
262 |
263 | d) Convey the object code by offering access from a designated
264 | place (gratis or for a charge), and offer equivalent access to the
265 | Corresponding Source in the same way through the same place at no
266 | further charge. You need not require recipients to copy the
267 | Corresponding Source along with the object code. If the place to
268 | copy the object code is a network server, the Corresponding Source
269 | may be on a different server (operated by you or a third party)
270 | that supports equivalent copying facilities, provided you maintain
271 | clear directions next to the object code saying where to find the
272 | Corresponding Source. Regardless of what server hosts the
273 | Corresponding Source, you remain obligated to ensure that it is
274 | available for as long as needed to satisfy these requirements.
275 |
276 | e) Convey the object code using peer-to-peer transmission, provided
277 | you inform other peers where the object code and Corresponding
278 | Source of the work are being offered to the general public at no
279 | charge under subsection 6d.
280 |
281 | A separable portion of the object code, whose source code is excluded
282 | from the Corresponding Source as a System Library, need not be
283 | included in conveying the object code work.
284 |
285 | A "User Product" is either (1) a "consumer product", which means any
286 | tangible personal property which is normally used for personal, family,
287 | or household purposes, or (2) anything designed or sold for incorporation
288 | into a dwelling. In determining whether a product is a consumer product,
289 | doubtful cases shall be resolved in favor of coverage. For a particular
290 | product received by a particular user, "normally used" refers to a
291 | typical or common use of that class of product, regardless of the status
292 | of the particular user or of the way in which the particular user
293 | actually uses, or expects or is expected to use, the product. A product
294 | is a consumer product regardless of whether the product has substantial
295 | commercial, industrial or non-consumer uses, unless such uses represent
296 | the only significant mode of use of the product.
297 |
298 | "Installation Information" for a User Product means any methods,
299 | procedures, authorization keys, or other information required to install
300 | and execute modified versions of a covered work in that User Product from
301 | a modified version of its Corresponding Source. The information must
302 | suffice to ensure that the continued functioning of the modified object
303 | code is in no case prevented or interfered with solely because
304 | modification has been made.
305 |
306 | If you convey an object code work under this section in, or with, or
307 | specifically for use in, a User Product, and the conveying occurs as
308 | part of a transaction in which the right of possession and use of the
309 | User Product is transferred to the recipient in perpetuity or for a
310 | fixed term (regardless of how the transaction is characterized), the
311 | Corresponding Source conveyed under this section must be accompanied
312 | by the Installation Information. But this requirement does not apply
313 | if neither you nor any third party retains the ability to install
314 | modified object code on the User Product (for example, the work has
315 | been installed in ROM).
316 |
317 | The requirement to provide Installation Information does not include a
318 | requirement to continue to provide support service, warranty, or updates
319 | for a work that has been modified or installed by the recipient, or for
320 | the User Product in which it has been modified or installed. Access to a
321 | network may be denied when the modification itself materially and
322 | adversely affects the operation of the network or violates the rules and
323 | protocols for communication across the network.
324 |
325 | Corresponding Source conveyed, and Installation Information provided,
326 | in accord with this section must be in a format that is publicly
327 | documented (and with an implementation available to the public in
328 | source code form), and must require no special password or key for
329 | unpacking, reading or copying.
330 |
331 | 7. Additional Terms.
332 |
333 | "Additional permissions" are terms that supplement the terms of this
334 | License by making exceptions from one or more of its conditions.
335 | Additional permissions that are applicable to the entire Program shall
336 | be treated as though they were included in this License, to the extent
337 | that they are valid under applicable law. If additional permissions
338 | apply only to part of the Program, that part may be used separately
339 | under those permissions, but the entire Program remains governed by
340 | this License without regard to the additional permissions.
341 |
342 | When you convey a copy of a covered work, you may at your option
343 | remove any additional permissions from that copy, or from any part of
344 | it. (Additional permissions may be written to require their own
345 | removal in certain cases when you modify the work.) You may place
346 | additional permissions on material, added by you to a covered work,
347 | for which you have or can give appropriate copyright permission.
348 |
349 | Notwithstanding any other provision of this License, for material you
350 | add to a covered work, you may (if authorized by the copyright holders of
351 | that material) supplement the terms of this License with terms:
352 |
353 | a) Disclaiming warranty or limiting liability differently from the
354 | terms of sections 15 and 16 of this License; or
355 |
356 | b) Requiring preservation of specified reasonable legal notices or
357 | author attributions in that material or in the Appropriate Legal
358 | Notices displayed by works containing it; or
359 |
360 | c) Prohibiting misrepresentation of the origin of that material, or
361 | requiring that modified versions of such material be marked in
362 | reasonable ways as different from the original version; or
363 |
364 | d) Limiting the use for publicity purposes of names of licensors or
365 | authors of the material; or
366 |
367 | e) Declining to grant rights under trademark law for use of some
368 | trade names, trademarks, or service marks; or
369 |
370 | f) Requiring indemnification of licensors and authors of that
371 | material by anyone who conveys the material (or modified versions of
372 | it) with contractual assumptions of liability to the recipient, for
373 | any liability that these contractual assumptions directly impose on
374 | those licensors and authors.
375 |
376 | All other non-permissive additional terms are considered "further
377 | restrictions" within the meaning of section 10. If the Program as you
378 | received it, or any part of it, contains a notice stating that it is
379 | governed by this License along with a term that is a further
380 | restriction, you may remove that term. If a license document contains
381 | a further restriction but permits relicensing or conveying under this
382 | License, you may add to a covered work material governed by the terms
383 | of that license document, provided that the further restriction does
384 | not survive such relicensing or conveying.
385 |
386 | If you add terms to a covered work in accord with this section, you
387 | must place, in the relevant source files, a statement of the
388 | additional terms that apply to those files, or a notice indicating
389 | where to find the applicable terms.
390 |
391 | Additional terms, permissive or non-permissive, may be stated in the
392 | form of a separately written license, or stated as exceptions;
393 | the above requirements apply either way.
394 |
395 | 8. Termination.
396 |
397 | You may not propagate or modify a covered work except as expressly
398 | provided under this License. Any attempt otherwise to propagate or
399 | modify it is void, and will automatically terminate your rights under
400 | this License (including any patent licenses granted under the third
401 | paragraph of section 11).
402 |
403 | However, if you cease all violation of this License, then your
404 | license from a particular copyright holder is reinstated (a)
405 | provisionally, unless and until the copyright holder explicitly and
406 | finally terminates your license, and (b) permanently, if the copyright
407 | holder fails to notify you of the violation by some reasonable means
408 | prior to 60 days after the cessation.
409 |
410 | Moreover, your license from a particular copyright holder is
411 | reinstated permanently if the copyright holder notifies you of the
412 | violation by some reasonable means, this is the first time you have
413 | received notice of violation of this License (for any work) from that
414 | copyright holder, and you cure the violation prior to 30 days after
415 | your receipt of the notice.
416 |
417 | Termination of your rights under this section does not terminate the
418 | licenses of parties who have received copies or rights from you under
419 | this License. If your rights have been terminated and not permanently
420 | reinstated, you do not qualify to receive new licenses for the same
421 | material under section 10.
422 |
423 | 9. Acceptance Not Required for Having Copies.
424 |
425 | You are not required to accept this License in order to receive or
426 | run a copy of the Program. Ancillary propagation of a covered work
427 | occurring solely as a consequence of using peer-to-peer transmission
428 | to receive a copy likewise does not require acceptance. However,
429 | nothing other than this License grants you permission to propagate or
430 | modify any covered work. These actions infringe copyright if you do
431 | not accept this License. Therefore, by modifying or propagating a
432 | covered work, you indicate your acceptance of this License to do so.
433 |
434 | 10. Automatic Licensing of Downstream Recipients.
435 |
436 | Each time you convey a covered work, the recipient automatically
437 | receives a license from the original licensors, to run, modify and
438 | propagate that work, subject to this License. You are not responsible
439 | for enforcing compliance by third parties with this License.
440 |
441 | An "entity transaction" is a transaction transferring control of an
442 | organization, or substantially all assets of one, or subdividing an
443 | organization, or merging organizations. If propagation of a covered
444 | work results from an entity transaction, each party to that
445 | transaction who receives a copy of the work also receives whatever
446 | licenses to the work the party's predecessor in interest had or could
447 | give under the previous paragraph, plus a right to possession of the
448 | Corresponding Source of the work from the predecessor in interest, if
449 | the predecessor has it or can get it with reasonable efforts.
450 |
451 | You may not impose any further restrictions on the exercise of the
452 | rights granted or affirmed under this License. For example, you may
453 | not impose a license fee, royalty, or other charge for exercise of
454 | rights granted under this License, and you may not initiate litigation
455 | (including a cross-claim or counterclaim in a lawsuit) alleging that
456 | any patent claim is infringed by making, using, selling, offering for
457 | sale, or importing the Program or any portion of it.
458 |
459 | 11. Patents.
460 |
461 | A "contributor" is a copyright holder who authorizes use under this
462 | License of the Program or a work on which the Program is based. The
463 | work thus licensed is called the contributor's "contributor version".
464 |
465 | A contributor's "essential patent claims" are all patent claims
466 | owned or controlled by the contributor, whether already acquired or
467 | hereafter acquired, that would be infringed by some manner, permitted
468 | by this License, of making, using, or selling its contributor version,
469 | but do not include claims that would be infringed only as a
470 | consequence of further modification of the contributor version. For
471 | purposes of this definition, "control" includes the right to grant
472 | patent sublicenses in a manner consistent with the requirements of
473 | this License.
474 |
475 | Each contributor grants you a non-exclusive, worldwide, royalty-free
476 | patent license under the contributor's essential patent claims, to
477 | make, use, sell, offer for sale, import and otherwise run, modify and
478 | propagate the contents of its contributor version.
479 |
480 | In the following three paragraphs, a "patent license" is any express
481 | agreement or commitment, however denominated, not to enforce a patent
482 | (such as an express permission to practice a patent or covenant not to
483 | sue for patent infringement). To "grant" such a patent license to a
484 | party means to make such an agreement or commitment not to enforce a
485 | patent against the party.
486 |
487 | If you convey a covered work, knowingly relying on a patent license,
488 | and the Corresponding Source of the work is not available for anyone
489 | to copy, free of charge and under the terms of this License, through a
490 | publicly available network server or other readily accessible means,
491 | then you must either (1) cause the Corresponding Source to be so
492 | available, or (2) arrange to deprive yourself of the benefit of the
493 | patent license for this particular work, or (3) arrange, in a manner
494 | consistent with the requirements of this License, to extend the patent
495 | license to downstream recipients. "Knowingly relying" means you have
496 | actual knowledge that, but for the patent license, your conveying the
497 | covered work in a country, or your recipient's use of the covered work
498 | in a country, would infringe one or more identifiable patents in that
499 | country that you have reason to believe are valid.
500 |
501 | If, pursuant to or in connection with a single transaction or
502 | arrangement, you convey, or propagate by procuring conveyance of, a
503 | covered work, and grant a patent license to some of the parties
504 | receiving the covered work authorizing them to use, propagate, modify
505 | or convey a specific copy of the covered work, then the patent license
506 | you grant is automatically extended to all recipients of the covered
507 | work and works based on it.
508 |
509 | A patent license is "discriminatory" if it does not include within
510 | the scope of its coverage, prohibits the exercise of, or is
511 | conditioned on the non-exercise of one or more of the rights that are
512 | specifically granted under this License. You may not convey a covered
513 | work if you are a party to an arrangement with a third party that is
514 | in the business of distributing software, under which you make payment
515 | to the third party based on the extent of your activity of conveying
516 | the work, and under which the third party grants, to any of the
517 | parties who would receive the covered work from you, a discriminatory
518 | patent license (a) in connection with copies of the covered work
519 | conveyed by you (or copies made from those copies), or (b) primarily
520 | for and in connection with specific products or compilations that
521 | contain the covered work, unless you entered into that arrangement,
522 | or that patent license was granted, prior to 28 March 2007.
523 |
524 | Nothing in this License shall be construed as excluding or limiting
525 | any implied license or other defenses to infringement that may
526 | otherwise be available to you under applicable patent law.
527 |
528 | 12. No Surrender of Others' Freedom.
529 |
530 | If conditions are imposed on you (whether by court order, agreement or
531 | otherwise) that contradict the conditions of this License, they do not
532 | excuse you from the conditions of this License. If you cannot convey a
533 | covered work so as to satisfy simultaneously your obligations under this
534 | License and any other pertinent obligations, then as a consequence you may
535 | not convey it at all. For example, if you agree to terms that obligate you
536 | to collect a royalty for further conveying from those to whom you convey
537 | the Program, the only way you could satisfy both those terms and this
538 | License would be to refrain entirely from conveying the Program.
539 |
540 | 13. Remote Network Interaction; Use with the GNU General Public License.
541 |
542 | Notwithstanding any other provision of this License, if you modify the
543 | Program, your modified version must prominently offer all users
544 | interacting with it remotely through a computer network (if your version
545 | supports such interaction) an opportunity to receive the Corresponding
546 | Source of your version by providing access to the Corresponding Source
547 | from a network server at no charge, through some standard or customary
548 | means of facilitating copying of software. This Corresponding Source
549 | shall include the Corresponding Source for any work covered by version 3
550 | of the GNU General Public License that is incorporated pursuant to the
551 | following paragraph.
552 |
553 | Notwithstanding any other provision of this License, you have
554 | permission to link or combine any covered work with a work licensed
555 | under version 3 of the GNU General Public License into a single
556 | combined work, and to convey the resulting work. The terms of this
557 | License will continue to apply to the part which is the covered work,
558 | but the work with which it is combined will remain governed by version
559 | 3 of the GNU General Public License.
560 |
561 | 14. Revised Versions of this License.
562 |
563 | The Free Software Foundation may publish revised and/or new versions of
564 | the GNU Affero General Public License from time to time. Such new versions
565 | will be similar in spirit to the present version, but may differ in detail to
566 | address new problems or concerns.
567 |
568 | Each version is given a distinguishing version number. If the
569 | Program specifies that a certain numbered version of the GNU Affero General
570 | Public License "or any later version" applies to it, you have the
571 | option of following the terms and conditions either of that numbered
572 | version or of any later version published by the Free Software
573 | Foundation. If the Program does not specify a version number of the
574 | GNU Affero General Public License, you may choose any version ever published
575 | by the Free Software Foundation.
576 |
577 | If the Program specifies that a proxy can decide which future
578 | versions of the GNU Affero General Public License can be used, that proxy's
579 | public statement of acceptance of a version permanently authorizes you
580 | to choose that version for the Program.
581 |
582 | Later license versions may give you additional or different
583 | permissions. However, no additional obligations are imposed on any
584 | author or copyright holder as a result of your choosing to follow a
585 | later version.
586 |
587 | 15. Disclaimer of Warranty.
588 |
589 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
590 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
591 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
592 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
593 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
594 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
595 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
596 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
597 |
598 | 16. Limitation of Liability.
599 |
600 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
601 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
602 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
603 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
604 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
605 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
606 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
607 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
608 | SUCH DAMAGES.
609 |
610 | 17. Interpretation of Sections 15 and 16.
611 |
612 | If the disclaimer of warranty and limitation of liability provided
613 | above cannot be given local legal effect according to their terms,
614 | reviewing courts shall apply local law that most closely approximates
615 | an absolute waiver of all civil liability in connection with the
616 | Program, unless a warranty or assumption of liability accompanies a
617 | copy of the Program in return for a fee.
618 |
619 | END OF TERMS AND CONDITIONS
620 |
621 | How to Apply These Terms to Your New Programs
622 |
623 | If you develop a new program, and you want it to be of the greatest
624 | possible use to the public, the best way to achieve this is to make it
625 | free software which everyone can redistribute and change under these terms.
626 |
627 | To do so, attach the following notices to the program. It is safest
628 | to attach them to the start of each source file to most effectively
629 | state the exclusion of warranty; and each file should have at least
630 | the "copyright" line and a pointer to where the full notice is found.
631 |
632 |
633 | Copyright (C)
634 |
635 | This program is free software: you can redistribute it and/or modify
636 | it under the terms of the GNU Affero General Public License as published by
637 | the Free Software Foundation, either version 3 of the License, or
638 | (at your option) any later version.
639 |
640 | This program is distributed in the hope that it will be useful,
641 | but WITHOUT ANY WARRANTY; without even the implied warranty of
642 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
643 | GNU Affero General Public License for more details.
644 |
645 | You should have received a copy of the GNU Affero General Public License
646 | along with this program. If not, see .
647 |
648 | Also add information on how to contact you by electronic and paper mail.
649 |
650 | If your software can interact with users remotely through a computer
651 | network, you should also make sure that it provides a way for users to
652 | get its source. For example, if your program is a web application, its
653 | interface could display a "Source" link that leads users to an archive
654 | of the code. There are many ways you could offer source, and different
655 | solutions will be better for different programs; see section 13 for the
656 | specific requirements.
657 |
658 | You should also get your employer (if you work as a programmer) or school,
659 | if any, to sign a "copyright disclaimer" for the program, if necessary.
660 | For more information on this, and how to apply and follow the GNU AGPL, see
661 | .
662 |
--------------------------------------------------------------------------------
/README.org:
--------------------------------------------------------------------------------
1 | #+title: Doubly Linked Circular List in C
2 |
3 | [[https://travis-ci.org/andschwa/c-list][https://travis-ci.org/andschwa/c-list.svg?branch=master]]
4 |
5 | This is a generic (=list_node= data is a void pointer) doubly linked
6 | (nodes have next and previous links) circular (=tail->next= points to
7 | head and =head->prev= points to tail) list library implemented in
8 | C. It uses a
9 | [[https://en.wikipedia.org/wiki/Linked_list#Using_sentinel_nodes][sentinel
10 | node]] to avoid every edge case one usually encounters when writing a
11 | linked list.
12 |
13 | This library was originally created for use in my
14 | [[https://github.com/andschwa/uidaho-cs445][120++ Compiler]], and has
15 | been updated since.
16 |
17 | * Efficiency
18 | It is highly performant, and allows the user to allocate nodes as they
19 | wish. Since it is doubly linked, both ends can be accessed
20 | (=list_front= and =list_back=), popped, and pushed in constant
21 | time. Insertions and deletions are obviously in linear time due to
22 | indexing, but the list is smart enough to traverse from the closest
23 | end, leading to worst case time of =n/2=. If you already have a handle
24 | to a node, unlinking it from the list is done in constant time.
25 |
26 | * Interface
27 | The list can be iterated over in a sugary syntactic fashion:
28 |
29 | #+begin_src C
30 | struct list_node *n = list_head(some_list);
31 | while (!list_end(n)) {
32 | /* do something with n->data */
33 | n = n->next;
34 | }
35 | #+end_src
36 |
37 | Being doubly linked, this can be done in reverse too. Just use
38 | =list_tail(some_list)= and =iter = iter->prev=. The list's sentinel
39 | node marks the end of the list.
40 |
41 | Push, pop, peek, insert, search, and delete all follow the naming
42 | scheme found in the C++ STL.
43 |
44 | * Unit Tests
45 | This library is unit tested (and all functions have comment
46 | headers). It utilizes my
47 | [[https://github.com/andschwa/c-unit-test][Simple C Unit Test
48 | Framework]], and runs on TravisCI. See =test_list.c= for example
49 | usage.
50 |
51 | * Building
52 | Being a library, compiling an object file is simple.
53 | #+begin_src sh
54 | gcc -std=gnu99 -c list.c
55 | #+end_src
56 |
57 | See =.travis.yml= for an example where it is linked to the unit tests.
58 |
--------------------------------------------------------------------------------
/list.c:
--------------------------------------------------------------------------------
1 | /*
2 | * list.c - Source code for doubly linked circular list.
3 | *
4 | * Copyright (C) 2014 Andrew Schwartzmeyer
5 | *
6 | * This file released under the AGPLv3 license.
7 | */
8 |
9 | #include
10 | #include
11 | #include
12 | #include
13 |
14 | #include "list.h"
15 |
16 | static void list_debug(const char *format, ...);
17 | static bool list_default_compare(void *a, void *b);
18 |
19 | /*
20 | * Returns allocated list with uncounted sentinel element.
21 | */
22 | struct list *list_new(bool (*compare)(void *a, void *b),
23 | void (*delete_)(void *data))
24 | {
25 | struct list *l = malloc(sizeof(*l));
26 | if (l == NULL) {
27 | perror("list_new()");
28 | return NULL;
29 | }
30 |
31 | /* A sentinel is used to elimnate edge cases everywhere else */
32 | struct list_node *sentinel = list_node_new(NULL);
33 | if (sentinel == NULL) {
34 | free(l);
35 | return NULL;
36 | }
37 |
38 | l->sentinel = sentinel;
39 | l->size = 0;
40 |
41 | sentinel->sentinel = true;
42 | sentinel->next = sentinel;
43 | sentinel->prev = sentinel;
44 |
45 | l->compare = (compare == NULL)
46 | ? &list_default_compare
47 | : compare;
48 |
49 | l->delete_ = delete_;
50 |
51 | return l;
52 | }
53 |
54 | /*
55 | * Inserts n at pos in O(n/2). Returns n if successful, else NULL.
56 | *
57 | * Position 0 inserts at the front and n inserts at the end in O(1).
58 | */
59 | struct list_node *list_insert(struct list *self, int pos, struct list_node *n)
60 | {
61 | if (self == NULL) {
62 | list_debug("list_insert(): self was NULL");
63 | return NULL;
64 | }
65 |
66 | n = list_node_link(n, list_index(self, pos));
67 | if (n)
68 | ++self->size;
69 | return n;
70 | }
71 |
72 | /*
73 | * Use compare function to return found node, else NULL.
74 | */
75 | struct list_node *list_search(struct list *self, void *data) {
76 | struct list_node *n = list_head(self);
77 | while (!list_end(n)) {
78 | if (self->compare(data, n->data))
79 | return n;
80 | n = n->next;
81 | }
82 | return NULL;
83 | }
84 |
85 | /*
86 | * Unlinks node from list at pos, returns node (to be freed).
87 | *
88 | * 0 is front, -1 (or n - 1), both are done in O(1). Else O(n/2).
89 | */
90 | struct list_node *list_delete(struct list *self, int pos)
91 | {
92 | if (self == NULL) {
93 | list_debug("list_delete(): self was NULL");
94 | return NULL;
95 | }
96 |
97 | struct list_node *n = list_node_unlink(list_index(self, pos));
98 | if (n)
99 | --self->size;
100 | return n;
101 | }
102 |
103 | /*
104 | * Pushes n to back of list in O(1).
105 | */
106 | struct list_node *list_push_back(struct list *self, struct list_node *n)
107 | {
108 | return list_insert(self, list_size(self), n);
109 | }
110 |
111 | /*
112 | * Pushes n to front of list in O(1).
113 | */
114 | struct list_node *list_push_front(struct list *self, struct list_node *n)
115 | {
116 | return list_insert(self, 0, n);
117 | }
118 |
119 | /*
120 | * Unlinks tail node of list in O(1). Returns node.
121 | */
122 | struct list_node *list_pop_back(struct list *self)
123 | {
124 | return list_delete(self, -1);
125 | }
126 |
127 | /*
128 | * Unlinks head node of list in O(1). Returns node.
129 | */
130 | struct list_node *list_pop_front(struct list *self)
131 | {
132 | return list_delete(self, 0);
133 | }
134 |
135 | /*
136 | * Returns pointer to data at tail of list in O(1).
137 | */
138 | void *list_back(struct list *self)
139 | {
140 | return list_tail(self)->data;
141 | }
142 |
143 | /*
144 | * Returns pointer to data at front of list in O(1).
145 | */
146 | void *list_front(struct list *self)
147 | {
148 | return list_head(self)->data;
149 | }
150 |
151 | /*
152 | * Returns pointer to head node of list in O(1).
153 | */
154 | struct list_node *list_head(struct list *self)
155 | {
156 | if (self == NULL) {
157 | list_debug("list_head(): self was NULL");
158 | return NULL;
159 | }
160 |
161 | if (!list_end(self->sentinel)) {
162 | list_debug("list_head(): sentinel was malformed");
163 | return NULL;
164 | }
165 |
166 | return self->sentinel->next;
167 | }
168 |
169 | /*
170 | * Returns pointer to tail node of list in O(1).
171 | */
172 | struct list_node *list_tail(struct list *self)
173 | {
174 | if (self == NULL) {
175 | list_debug("list_tail(): self was NULL");
176 | return NULL;
177 | }
178 |
179 | if (!list_end(self->sentinel)) {
180 | list_debug("list_tail(): sentinel was malformed");
181 | return NULL;
182 | }
183 |
184 | return self->sentinel->prev;
185 | }
186 |
187 | /*
188 | * Returns node at pos in O(n/2).
189 | *
190 | * Iterates from the closest end. Supports negative pos arguments.
191 | */
192 | struct list_node *list_index(struct list *self, int pos)
193 | {
194 | int s = list_size(self);
195 |
196 | /* handle negative positions */
197 | if (pos < 0)
198 | pos += s;
199 |
200 | struct list_node *n = NULL;
201 |
202 |
203 | if (pos <= s/2) {
204 | n = list_head(self);
205 | for (int i = 0; i < pos; ++i)
206 | n = n->next;
207 | } else {
208 | n = self->sentinel; /* for push_back */
209 | for (int i = s; i > pos; --i)
210 | n = n->prev;
211 | }
212 |
213 | return n;
214 | }
215 |
216 | /*
217 | * Returns the number of nodes in list. Does not count the sentinel.
218 | */
219 | size_t list_size(struct list *self)
220 | {
221 | if (self == NULL) {
222 | list_debug("list_size(): self was NULL");
223 | return 0;
224 | }
225 |
226 | return self->size;
227 | }
228 |
229 | /*
230 | * Helper to check if size is 0.
231 | */
232 | bool list_empty(struct list *self)
233 | {
234 | return (list_size(self) == 0);
235 | }
236 |
237 | /*
238 | * Returns true if n was the sentinel.
239 | *
240 | * This is an indication that an iteration has reached the end of the
241 | * list. *Not* the last data-carrying node of the list.
242 | */
243 | bool list_end(struct list_node *n)
244 | {
245 | if (n == NULL) {
246 | list_debug("list_end(): n was NULL");
247 | return false;
248 | }
249 |
250 | return n->sentinel;
251 | }
252 |
253 | /*
254 | * Concatenates list b to the end of list a destructively.
255 | *
256 | * usage: a = list_concat(a, b);
257 | *
258 | * List b (and its sentinel) will be freed. The nodes of list b will
259 | * therefore be accessible only through their new place in list a.
260 | *
261 | * Require that compare and delete functions are the same. Relative
262 | * assurance that lists contain same kinds of items.
263 | *
264 | * If either is an empty list, the other is returned. Hence the
265 | * recommended usage with assignment.
266 | *
267 | * Returns list a on success, NULL on failure.
268 | */
269 | struct list *list_concat(struct list *a, struct list *b)
270 | {
271 | if (a && !b)
272 | return a;
273 | if (b && !a)
274 | return b;
275 |
276 | if (!a && !b) {
277 | list_debug("list_concat(): no list given");
278 | return NULL;
279 | }
280 |
281 | if (a->compare != b->compare) {
282 | list_debug("list_concat(): compare functions unequal");
283 | return NULL;
284 | }
285 |
286 | if (a->delete_ != b->delete_) {
287 | list_debug("list_concat(): delete functions unequal");
288 | return NULL;
289 | }
290 |
291 | /* link head of b to tail of a */
292 | list_tail(a)->next = list_head(b);
293 | list_head(b)->prev = list_tail(a);
294 |
295 | /* link tail of b to sentinal of a */
296 | list_tail(b)->next = a->sentinel;
297 | a->sentinel->prev = list_tail(b);
298 |
299 | a->size += b->size;
300 |
301 | free(b->sentinel);
302 | free(b);
303 |
304 | return a;
305 | }
306 |
307 | /*
308 | * Use function to free data of each node, then free said node,
309 | * finally free the sentinel and the list.
310 | */
311 | void list_free(struct list *self)
312 | {
313 | while (!list_empty(self)) {
314 | struct list_node *n = list_pop_back(self);
315 | if (self->delete_)
316 | self->delete_(n->data);
317 | free(n);
318 | }
319 |
320 | free(self->sentinel);
321 | free(self);
322 | }
323 |
324 | /*
325 | * Default comparison for list of strings.
326 | */
327 | static bool list_default_compare(void *a, void *b)
328 | {
329 | return (strcmp((char *)a, (char *)b) == 0);
330 | }
331 |
332 | /*
333 | * Allocates new list_node with data.
334 | *
335 | * Sentinel flag is false. The next and prev pointers are null.
336 | */
337 | struct list_node *list_node_new(void *data)
338 | {
339 | struct list_node *n = malloc(sizeof(*n));
340 | if (n == NULL) {
341 | perror("list_node_new()");
342 | return NULL;
343 | }
344 |
345 | n->sentinel = false;
346 | n->next = NULL;
347 | n->prev = NULL;
348 | n->data = data;
349 |
350 | return n;
351 | }
352 |
353 | /*
354 | * Given (a _ c), links b (new) leaving (a b c) in O(1).
355 | *
356 | * Node a is found from c, so with b and c as parameters, this
357 | * prepends (think cons).
358 | *
359 | * Size is not incremented!
360 | */
361 | struct list_node *list_node_link(struct list_node *b, struct list_node *c)
362 | {
363 | if (b == NULL) {
364 | list_debug("list_node_link(): b was NULL");
365 | return NULL;
366 | }
367 |
368 | if (c == NULL) {
369 | list_debug("list_node_link(): c was NULL");
370 | return NULL;
371 | }
372 |
373 | struct list_node *a = c->prev;
374 |
375 | a->next = b;
376 | b->prev = a;
377 | b->next = c;
378 | c->prev = b;
379 |
380 | return b;
381 | }
382 |
383 | /*
384 | * Given (a b c), unlinks b leaving (a _ c) in O(1).
385 | *
386 | * Nodes a and c are found from b. Yay double links.
387 | *
388 | * Size is not decremented!
389 | */
390 | struct list_node *list_node_unlink(struct list_node *b)
391 | {
392 | if (list_end(b)) {
393 | return NULL;
394 | }
395 |
396 | struct list_node *a = b->prev;
397 | struct list_node *c = b->next;
398 |
399 | a->next = c;
400 | c->prev = a;
401 |
402 | return b;
403 | }
404 |
405 | static void list_debug(const char *format, ...)
406 | {
407 | if (!LIST_DEBUG)
408 | return;
409 |
410 | va_list ap;
411 | va_start(ap, format);
412 |
413 | fprintf(stderr, "debug: ");
414 | vfprintf(stderr, format, ap);
415 | fprintf(stderr, "\n");
416 |
417 | va_end(ap);
418 | }
419 |
--------------------------------------------------------------------------------
/list.h:
--------------------------------------------------------------------------------
1 | /*
2 | * list.h - Interface for doubly linked circular list.
3 | *
4 | * Copyright (C) 2014 Andrew Schwartzmeyer
5 | *
6 | * This file released under the AGPLv3 license.
7 | */
8 |
9 | #ifndef LIST_H
10 | #define LIST_H
11 |
12 | #include
13 | #include
14 |
15 | #ifndef LIST_DEBUG
16 | #define LIST_DEBUG 0
17 | #endif
18 |
19 | struct list_node
20 | {
21 | struct list_node *next;
22 | struct list_node *prev;
23 | bool sentinel;
24 | void *data;
25 | };
26 |
27 | struct list
28 | {
29 | struct list_node *sentinel;
30 | size_t size;
31 | bool (*compare)(void *, void *);
32 | void (*delete_)(void *);
33 | };
34 |
35 | struct list *list_new(bool (*compare)(void *, void *), void (*delete_)(void *));
36 |
37 | struct list_node *list_insert(struct list *self, int pos, struct list_node *n);
38 | struct list_node *list_search(struct list *self, void *data);
39 | struct list_node *list_delete(struct list *self, int pos);
40 |
41 | struct list_node *list_push_back(struct list *self, struct list_node *n);
42 | struct list_node *list_push_front(struct list *self, struct list_node *n);
43 |
44 | struct list_node *list_pop_back(struct list *self);
45 | struct list_node *list_pop_front(struct list *self);
46 |
47 | void *list_back(struct list *self);
48 | void *list_front(struct list *self);
49 |
50 | struct list_node *list_head(struct list *self);
51 | struct list_node *list_tail(struct list *self);
52 |
53 | struct list_node *list_index(struct list *self, int pos);
54 |
55 | size_t list_size(struct list *self);
56 | bool list_empty(struct list *self);
57 | bool list_end(struct list_node *n);
58 | struct list *list_concat(struct list *a, struct list *b);
59 |
60 | void list_free(struct list *self);
61 |
62 | struct list_node *list_node_new(void *data);
63 | struct list_node *list_node_link(struct list_node *a, struct list_node *b);
64 | struct list_node *list_node_unlink(struct list_node *b);
65 |
66 | #endif /* LIST_H */
67 |
--------------------------------------------------------------------------------
/test_list.c:
--------------------------------------------------------------------------------
1 | /*
2 | * test_list.c - Unit test code for doubly linked list with sentinel.
3 | *
4 | * Copyright (C) 2014 Andrew Schwartzmeyer
5 | *
6 | * This file released under the AGPLv3 license.
7 | */
8 |
9 | #include
10 | #include
11 | #include
12 |
13 | #include "test/test.h"
14 | #include "list.h"
15 |
16 | void test_new(struct list *list);
17 | void test_sentinel(struct list *list);
18 | void test_size(struct list *list, size_t size);
19 | void test_empty(struct list *list);
20 | void test_empty_sentinel(struct list *list);
21 | void test_empty_ends(struct list *list);
22 | void test_non_empty(struct list *list);
23 | void test_head_data(struct list *list, char *data);
24 | void test_tail_data(struct list *list, char *data);
25 | void test_search_data(struct list *list, char* data);
26 | void test_not_search_data(struct list *list, char* data);
27 | void test_iter_forward(struct list *list);
28 | void test_iter_backward(struct list *list);
29 |
30 | int main()
31 | {
32 | running("list");
33 |
34 | testing("new");
35 | struct list *list = list_new(NULL, &free);
36 | test_new(list);
37 | test_sentinel(list);
38 | test_empty(list);
39 | test_empty_sentinel(list);
40 | test_empty_ends(list);
41 |
42 | testing("push back (A)");
43 | char *a = strdup("(A)");
44 | list_push_back(list, list_node_new(a));
45 |
46 | testing("head and tail");
47 | test_head_data(list, a);
48 | test_tail_data(list, a);
49 |
50 | testing("search (A)");
51 | test_search_data(list, "(A)");
52 |
53 | testing("not search (B)");
54 | test_not_search_data(list, "(B)");
55 |
56 | testing("push back (B)");
57 | char *b = strdup("(B)");
58 | list_push_back(list, list_node_new(b));
59 | test_tail_data(list, b);
60 |
61 | testing("push front (B)");
62 | list_push_front(list, list_node_new(b));
63 | test_head_data(list, b);
64 |
65 | testing("not empty");
66 | test_non_empty(list);
67 | test_size(list, 3);
68 |
69 | testing("pop back");
70 | free(list_pop_back(list));
71 | test_tail_data(list, a);
72 |
73 | testing("pop front");
74 | free(list_pop_front(list));
75 | test_head_data(list, a);
76 |
77 | testing("emptied");
78 | free(list_pop_back(list));
79 | test_empty(list);
80 |
81 | testing("(A) concat (B) (C)");
82 | struct list *list_ = list_new(NULL, &free);
83 | char *c = strdup("(C)");
84 | list_push_back(list, list_node_new(a));
85 | list_push_back(list_, list_node_new(b));
86 | list_push_back(list_, list_node_new(c));
87 | test_size(list, 1);
88 | test_size(list_, 2);
89 | test_head_data(list, a);
90 | test_head_data(list_, b);
91 | test_tail_data(list_, c);
92 | list_concat(list, list_);
93 | test_head_data(list, a);
94 | test_tail_data(list, c);
95 | test_size(list, 3);
96 |
97 | testing("forward iteration:");
98 | test_iter_forward(list);
99 |
100 | testing("backward iteration:");
101 | test_iter_backward(list);
102 |
103 | list_free(list);
104 |
105 | return status;
106 | }
107 |
108 | void test_new(struct list *list)
109 | {
110 | if (list == NULL)
111 | failure("list should not have been null");
112 | }
113 |
114 | void test_sentinel(struct list *list)
115 | {
116 | struct list_node *sentinel = list->sentinel;
117 |
118 | if (!sentinel->sentinel)
119 | failure("sentinel should be marked as such");
120 |
121 | if (!list_end(sentinel))
122 | failure("sentinel should have been list end");
123 | }
124 |
125 | void test_size(struct list *list, size_t size)
126 | {
127 | if (list_size(list) != size)
128 | failure("size should have been %lu", size);
129 | }
130 |
131 | void test_empty(struct list *list)
132 | {
133 | test_size(list, 0);
134 |
135 | if (!list_empty(list))
136 | failure("empty list should have been empty");
137 | }
138 |
139 | void test_empty_sentinel(struct list *list)
140 | {
141 | struct list_node *sentinel = list->sentinel;
142 |
143 | if (sentinel != list_head(list))
144 | failure("empty list sentinel should equal head");
145 |
146 | if (sentinel != list_tail(list))
147 | failure("empty list sentinel should equal tail");
148 |
149 | if (sentinel->next != sentinel)
150 | failure("empty list sentinel next should be itself");
151 |
152 | if (sentinel->prev != sentinel)
153 | failure("empty list sentinel prev should be itself");
154 | }
155 |
156 | void test_empty_ends(struct list *list)
157 | {
158 | struct list_node *head = list_head(list);
159 | struct list_node *tail = list_tail(list);
160 |
161 | if (head != tail)
162 | failure("empty list head should equal tail");
163 |
164 | if (!list_end(head))
165 | failure("empty list head should have been end");
166 | }
167 |
168 | void test_non_empty(struct list *list)
169 | {
170 | if (list_empty(list))
171 | failure("should not have been empty");
172 | }
173 |
174 | void test_head_data(struct list *list, char *data)
175 | {
176 | if (strcmp(list_front(list), data) != 0)
177 | failure("head should have been '%s'", data);
178 | }
179 |
180 | void test_tail_data(struct list *list, char *data)
181 | {
182 | if (strcmp(list_back(list), data) != 0)
183 | failure("tail should have been '%s'", data);
184 | }
185 |
186 | void test_search_data(struct list *list, char* data)
187 | {
188 | if (!list_search(list, data))
189 | failure("list should have had '%s'", data);
190 | }
191 |
192 | void test_not_search_data(struct list *list, char* data)
193 | {
194 | if (list_search(list, data))
195 | failure("list should not have had '%s'", data);
196 | }
197 |
198 | void test_iter_forward(struct list *list)
199 | {
200 | struct list_node *iter = list_head(list);
201 | size_t counter = 0;
202 | while (!list_end(iter)) {
203 | ++counter;
204 | if (LIST_DEBUG)
205 | printf("%s ", (char *)iter->data);
206 | iter = iter->next;
207 | }
208 | if (LIST_DEBUG)
209 | printf("\n");
210 | if (counter != list_size(list))
211 | failure("iter forward counted %lu, but had size %lu",
212 | counter, list_size(list));
213 | }
214 |
215 | void test_iter_backward(struct list *list)
216 | {
217 | struct list_node *iter = list_tail(list);
218 | size_t counter = 0;
219 | while (!list_end(iter)) {
220 | ++counter;
221 | if (LIST_DEBUG)
222 | printf("%s ", (char *)iter->data);
223 | iter = iter->prev;
224 | }
225 | if (LIST_DEBUG)
226 | printf("\n");
227 | if (counter != list_size(list))
228 | failure("iter backward counted %lu, but had size %lu",
229 | counter, list_size(list));
230 | }
231 |
--------------------------------------------------------------------------------