so://phie

cdoc

Lazy documentation parser for C
git clone git://soophie.de/cdoc

• log
• tree
• refs
• README
• LICENSE
• docs

branch:main

• LICENSE [new file]

  1                    GNU GENERAL PUBLIC LICENSE
  2                       Version 3, 29 June 2007
  3
  4 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
  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 General Public License is a free, copyleft license for
  11software and other kinds of works.
  12
  13  The licenses for most software and other practical works are designed
  14to take away your freedom to share and change the works.  By contrast,
  15the GNU General Public License is intended to guarantee your freedom to
  16share and change all versions of a program--to make sure it remains free
  17software for all its users.  We, the Free Software Foundation, use the
  18GNU General Public License for most of our software; it applies also to
  19any other work released this way by its authors.  You can apply it to
  20your programs, too.
  21
  22  When we speak of free software, we are referring to freedom, not
  23price.  Our General Public Licenses are designed to make sure that you
  24have the freedom to distribute copies of free software (and charge for
  25them if you wish), that you receive source code or can get it if you
  26want it, that you can change the software or use pieces of it in new
  27free programs, and that you know you can do these things.
  28
  29  To protect your rights, we need to prevent others from denying you
  30these rights or asking you to surrender the rights.  Therefore, you have
  31certain responsibilities if you distribute copies of the software, or if
  32you modify it: responsibilities to respect the freedom of others.
  33
  34  For example, if you distribute copies of such a program, whether
  35gratis or for a fee, you must pass on to the recipients the same
  36freedoms that you received.  You must make sure that they, too, receive
  37or can get the source code.  And you must show them these terms so they
  38know their rights.
  39
  40  Developers that use the GNU GPL protect your rights with two steps:
  41(1) assert copyright on the software, and (2) offer you this License
  42giving you legal permission to copy, distribute and/or modify it.
  43
  44  For the developers' and authors' protection, the GPL clearly explains
  45that there is no warranty for this free software.  For both users' and
  46authors' sake, the GPL requires that modified versions be marked as
  47changed, so that their problems will not be attributed erroneously to
  48authors of previous versions.
  49
  50  Some devices are designed to deny users access to install or run
  51modified versions of the software inside them, although the manufacturer
  52can do so.  This is fundamentally incompatible with the aim of
  53protecting users' freedom to change the software.  The systematic
  54pattern of such abuse occurs in the area of products for individuals to
  55use, which is precisely where it is most unacceptable.  Therefore, we
  56have designed this version of the GPL to prohibit the practice for those
  57products.  If such problems arise substantially in other domains, we
  58stand ready to extend this provision to those domains in future versions
  59of the GPL, as needed to protect the freedom of users.
  60
  61  Finally, every program is threatened constantly by software patents.
  62States should not allow patents to restrict development and use of
  63software on general-purpose computers, but in those that do, we wish to
  64avoid the special danger that patents applied to a free program could
  65make it effectively proprietary.  To prevent this, the GPL assures that
  66patents cannot be used to render the program non-free.
  67
  68  The precise terms and conditions for copying, distribution and
  69modification follow.
  70
  71                       TERMS AND CONDITIONS
  72
  73  0. Definitions.
  74
  75  "This License" refers to version 3 of the GNU General Public License.
  76
  77  "Copyright" also means copyright-like laws that apply to other kinds of
  78works, such as semiconductor masks.
  79
  80  "The Program" refers to any copyrightable work licensed under this
  81License.  Each licensee is addressed as "you".  "Licensees" and
  82"recipients" may be individuals or organizations.
  83
  84  To "modify" a work means to copy from or adapt all or part of the work
  85in a fashion requiring copyright permission, other than the making of an
  86exact copy.  The resulting work is called a "modified version" of the
  87earlier work or a work "based on" the earlier work.
  88
  89  A "covered work" means either the unmodified Program or a work based
  90on the Program.
  91
  92  To "propagate" a work means to do anything with it that, without
  93permission, would make you directly or secondarily liable for
  94infringement under applicable copyright law, except executing it on a
  95computer or modifying a private copy.  Propagation includes copying,
  96distribution (with or without modification), making available to the
  97public, and in some countries other activities as well.
  98
  99  To "convey" a work means any kind of propagation that enables other
  100parties to make or receive copies.  Mere interaction with a user through
  101a computer network, with no transfer of a copy, is not conveying.
  102
  103  An interactive user interface displays "Appropriate Legal Notices"
  104to the extent that it includes a convenient and prominently visible
  105feature that (1) displays an appropriate copyright notice, and (2)
  106tells the user that there is no warranty for the work (except to the
  107extent that warranties are provided), that licensees may convey the
  108work under this License, and how to view a copy of this License.  If
  109the interface presents a list of user commands or options, such as a
  110menu, a prominent item in the list meets this criterion.
  111
  112  1. Source Code.
  113
  114  The "source code" for a work means the preferred form of the work
  115for making modifications to it.  "Object code" means any non-source
  116form of a work.
  117
  118  A "Standard Interface" means an interface that either is an official
  119standard defined by a recognized standards body, or, in the case of
  120interfaces specified for a particular programming language, one that
  121is widely used among developers working in that language.
  122
  123  The "System Libraries" of an executable work include anything, other
  124than the work as a whole, that (a) is included in the normal form of
  125packaging a Major Component, but which is not part of that Major
  126Component, and (b) serves only to enable use of the work with that
  127Major Component, or to implement a Standard Interface for which an
  128implementation is available to the public in source code form.  A
  129"Major Component", in this context, means a major essential component
  130(kernel, window system, and so on) of the specific operating system
  131(if any) on which the executable work runs, or a compiler used to
  132produce the work, or an object code interpreter used to run it.
  133
  134  The "Corresponding Source" for a work in object code form means all
  135the source code needed to generate, install, and (for an executable
  136work) run the object code and to modify the work, including scripts to
  137control those activities.  However, it does not include the work's
  138System Libraries, or general-purpose tools or generally available free
  139programs which are used unmodified in performing those activities but
  140which are not part of the work.  For example, Corresponding Source
  141includes interface definition files associated with source files for
  142the work, and the source code for shared libraries and dynamically
  143linked subprograms that the work is specifically designed to require,
  144such as by intimate data communication or control flow between those
  145subprograms and other parts of the work.
  146
  147  The Corresponding Source need not include anything that users
  148can regenerate automatically from other parts of the Corresponding
  149Source.
  150
  151  The Corresponding Source for a work in source code form is that
  152same work.
  153
  154  2. Basic Permissions.
  155
  156  All rights granted under this License are granted for the term of
  157copyright on the Program, and are irrevocable provided the stated
  158conditions are met.  This License explicitly affirms your unlimited
  159permission to run the unmodified Program.  The output from running a
  160covered work is covered by this License only if the output, given its
  161content, constitutes a covered work.  This License acknowledges your
  162rights of fair use or other equivalent, as provided by copyright law.
  163
  164  You may make, run and propagate covered works that you do not
  165convey, without conditions so long as your license otherwise remains
  166in force.  You may convey covered works to others for the sole purpose
  167of having them make modifications exclusively for you, or provide you
  168with facilities for running those works, provided that you comply with
  169the terms of this License in conveying all material for which you do
  170not control copyright.  Those thus making or running the covered works
  171for you must do so exclusively on your behalf, under your direction
  172and control, on terms that prohibit them from making any copies of
  173your copyrighted material outside their relationship with you.
  174
  175  Conveying under any other circumstances is permitted solely under
  176the conditions stated below.  Sublicensing is not allowed; section 10
  177makes it unnecessary.
  178
  179  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
  180
  181  No covered work shall be deemed part of an effective technological
  182measure under any applicable law fulfilling obligations under article
  18311 of the WIPO copyright treaty adopted on 20 December 1996, or
  184similar laws prohibiting or restricting circumvention of such
  185measures.
  186
  187  When you convey a covered work, you waive any legal power to forbid
  188circumvention of technological measures to the extent such circumvention
  189is effected by exercising rights under this License with respect to
  190the covered work, and you disclaim any intention to limit operation or
  191modification of the work as a means of enforcing, against the work's
  192users, your or third parties' legal rights to forbid circumvention of
  193technological measures.
  194
  195  4. Conveying Verbatim Copies.
  196
  197  You may convey verbatim copies of the Program's source code as you
  198receive it, in any medium, provided that you conspicuously and
  199appropriately publish on each copy an appropriate copyright notice;
  200keep intact all notices stating that this License and any
  201non-permissive terms added in accord with section 7 apply to the code;
  202keep intact all notices of the absence of any warranty; and give all
  203recipients a copy of this License along with the Program.
  204
  205  You may charge any price or no price for each copy that you convey,
  206and you may offer support or warranty protection for a fee.
  207
  208  5. Conveying Modified Source Versions.
  209
  210  You may convey a work based on the Program, or the modifications to
  211produce it from the Program, in the form of source code under the
  212terms of section 4, provided that you also meet all of these conditions:
  213
  214    a) The work must carry prominent notices stating that you modified
  215    it, and giving a relevant date.
  216
  217    b) The work must carry prominent notices stating that it is
  218    released under this License and any conditions added under section
  219    7.  This requirement modifies the requirement in section 4 to
  220    "keep intact all notices".
  221
  222    c) You must license the entire work, as a whole, under this
  223    License to anyone who comes into possession of a copy.  This
  224    License will therefore apply, along with any applicable section 7
  225    additional terms, to the whole of the work, and all its parts,
  226    regardless of how they are packaged.  This License gives no
  227    permission to license the work in any other way, but it does not
  228    invalidate such permission if you have separately received it.
  229
  230    d) If the work has interactive user interfaces, each must display
  231    Appropriate Legal Notices; however, if the Program has interactive
  232    interfaces that do not display Appropriate Legal Notices, your
  233    work need not make them do so.
  234
  235  A compilation of a covered work with other separate and independent
  236works, which are not by their nature extensions of the covered work,
  237and which are not combined with it such as to form a larger program,
  238in or on a volume of a storage or distribution medium, is called an
  239"aggregate" if the compilation and its resulting copyright are not
  240used to limit the access or legal rights of the compilation's users
  241beyond what the individual works permit.  Inclusion of a covered work
  242in an aggregate does not cause this License to apply to the other
  243parts of the aggregate.
  244
  245  6. Conveying Non-Source Forms.
  246
  247  You may convey a covered work in object code form under the terms
  248of sections 4 and 5, provided that you also convey the
  249machine-readable Corresponding Source under the terms of this License,
  250in one of these ways:
  251
  252    a) Convey the object code in, or embodied in, a physical product
  253    (including a physical distribution medium), accompanied by the
  254    Corresponding Source fixed on a durable physical medium
  255    customarily used for software interchange.
  256
  257    b) Convey the object code in, or embodied in, a physical product
  258    (including a physical distribution medium), accompanied by a
  259    written offer, valid for at least three years and valid for as
  260    long as you offer spare parts or customer support for that product
  261    model, to give anyone who possesses the object code either (1) a
  262    copy of the Corresponding Source for all the software in the
  263    product that is covered by this License, on a durable physical
  264    medium customarily used for software interchange, for a price no
  265    more than your reasonable cost of physically performing this
  266    conveying of source, or (2) access to copy the
  267    Corresponding Source from a network server at no charge.
  268
  269    c) Convey individual copies of the object code with a copy of the
  270    written offer to provide the Corresponding Source.  This
  271    alternative is allowed only occasionally and noncommercially, and
  272    only if you received the object code with such an offer, in accord
  273    with subsection 6b.
  274
  275    d) Convey the object code by offering access from a designated
  276    place (gratis or for a charge), and offer equivalent access to the
  277    Corresponding Source in the same way through the same place at no
  278    further charge.  You need not require recipients to copy the
  279    Corresponding Source along with the object code.  If the place to
  280    copy the object code is a network server, the Corresponding Source
  281    may be on a different server (operated by you or a third party)
  282    that supports equivalent copying facilities, provided you maintain
  283    clear directions next to the object code saying where to find the
  284    Corresponding Source.  Regardless of what server hosts the
  285    Corresponding Source, you remain obligated to ensure that it is
  286    available for as long as needed to satisfy these requirements.
  287
  288    e) Convey the object code using peer-to-peer transmission, provided
  289    you inform other peers where the object code and Corresponding
  290    Source of the work are being offered to the general public at no
  291    charge under subsection 6d.
  292
  293  A separable portion of the object code, whose source code is excluded
  294from the Corresponding Source as a System Library, need not be
  295included in conveying the object code work.
  296
  297  A "User Product" is either (1) a "consumer product", which means any
  298tangible personal property which is normally used for personal, family,
  299or household purposes, or (2) anything designed or sold for incorporation
  300into a dwelling.  In determining whether a product is a consumer product,
  301doubtful cases shall be resolved in favor of coverage.  For a particular
  302product received by a particular user, "normally used" refers to a
  303typical or common use of that class of product, regardless of the status
  304of the particular user or of the way in which the particular user
  305actually uses, or expects or is expected to use, the product.  A product
  306is a consumer product regardless of whether the product has substantial
  307commercial, industrial or non-consumer uses, unless such uses represent
  308the only significant mode of use of the product.
  309
  310  "Installation Information" for a User Product means any methods,
  311procedures, authorization keys, or other information required to install
  312and execute modified versions of a covered work in that User Product from
  313a modified version of its Corresponding Source.  The information must
  314suffice to ensure that the continued functioning of the modified object
  315code is in no case prevented or interfered with solely because
  316modification has been made.
  317
  318  If you convey an object code work under this section in, or with, or
  319specifically for use in, a User Product, and the conveying occurs as
  320part of a transaction in which the right of possession and use of the
  321User Product is transferred to the recipient in perpetuity or for a
  322fixed term (regardless of how the transaction is characterized), the
  323Corresponding Source conveyed under this section must be accompanied
  324by the Installation Information.  But this requirement does not apply
  325if neither you nor any third party retains the ability to install
  326modified object code on the User Product (for example, the work has
  327been installed in ROM).
  328
  329  The requirement to provide Installation Information does not include a
  330requirement to continue to provide support service, warranty, or updates
  331for a work that has been modified or installed by the recipient, or for
  332the User Product in which it has been modified or installed.  Access to a
  333network may be denied when the modification itself materially and
  334adversely affects the operation of the network or violates the rules and
  335protocols for communication across the network.
  336
  337  Corresponding Source conveyed, and Installation Information provided,
  338in accord with this section must be in a format that is publicly
  339documented (and with an implementation available to the public in
  340source code form), and must require no special password or key for
  341unpacking, reading or copying.
  342
  343  7. Additional Terms.
  344
  345  "Additional permissions" are terms that supplement the terms of this
  346License by making exceptions from one or more of its conditions.
  347Additional permissions that are applicable to the entire Program shall
  348be treated as though they were included in this License, to the extent
  349that they are valid under applicable law.  If additional permissions
  350apply only to part of the Program, that part may be used separately
  351under those permissions, but the entire Program remains governed by
  352this License without regard to the additional permissions.
  353
  354  When you convey a copy of a covered work, you may at your option
  355remove any additional permissions from that copy, or from any part of
  356it.  (Additional permissions may be written to require their own
  357removal in certain cases when you modify the work.)  You may place
  358additional permissions on material, added by you to a covered work,
  359for which you have or can give appropriate copyright permission.
  360
  361  Notwithstanding any other provision of this License, for material you
  362add to a covered work, you may (if authorized by the copyright holders of
  363that material) supplement the terms of this License with terms:
  364
  365    a) Disclaiming warranty or limiting liability differently from the
  366    terms of sections 15 and 16 of this License; or
  367
  368    b) Requiring preservation of specified reasonable legal notices or
  369    author attributions in that material or in the Appropriate Legal
  370    Notices displayed by works containing it; or
  371
  372    c) Prohibiting misrepresentation of the origin of that material, or
  373    requiring that modified versions of such material be marked in
  374    reasonable ways as different from the original version; or
  375
  376    d) Limiting the use for publicity purposes of names of licensors or
  377    authors of the material; or
  378
  379    e) Declining to grant rights under trademark law for use of some
  380    trade names, trademarks, or service marks; or
  381
  382    f) Requiring indemnification of licensors and authors of that
  383    material by anyone who conveys the material (or modified versions of
  384    it) with contractual assumptions of liability to the recipient, for
  385    any liability that these contractual assumptions directly impose on
  386    those licensors and authors.
  387
  388  All other non-permissive additional terms are considered "further
  389restrictions" within the meaning of section 10.  If the Program as you
  390received it, or any part of it, contains a notice stating that it is
  391governed by this License along with a term that is a further
  392restriction, you may remove that term.  If a license document contains
  393a further restriction but permits relicensing or conveying under this
  394License, you may add to a covered work material governed by the terms
  395of that license document, provided that the further restriction does
  396not survive such relicensing or conveying.
  397
  398  If you add terms to a covered work in accord with this section, you
  399must place, in the relevant source files, a statement of the
  400additional terms that apply to those files, or a notice indicating
  401where to find the applicable terms.
  402
  403  Additional terms, permissive or non-permissive, may be stated in the
  404form of a separately written license, or stated as exceptions;
  405the above requirements apply either way.
  406
  407  8. Termination.
  408
  409  You may not propagate or modify a covered work except as expressly
  410provided under this License.  Any attempt otherwise to propagate or
  411modify it is void, and will automatically terminate your rights under
  412this License (including any patent licenses granted under the third
  413paragraph of section 11).
  414
  415  However, if you cease all violation of this License, then your
  416license from a particular copyright holder is reinstated (a)
  417provisionally, unless and until the copyright holder explicitly and
  418finally terminates your license, and (b) permanently, if the copyright
  419holder fails to notify you of the violation by some reasonable means
  420prior to 60 days after the cessation.
  421
  422  Moreover, your license from a particular copyright holder is
  423reinstated permanently if the copyright holder notifies you of the
  424violation by some reasonable means, this is the first time you have
  425received notice of violation of this License (for any work) from that
  426copyright holder, and you cure the violation prior to 30 days after
  427your receipt of the notice.
  428
  429  Termination of your rights under this section does not terminate the
  430licenses of parties who have received copies or rights from you under
  431this License.  If your rights have been terminated and not permanently
  432reinstated, you do not qualify to receive new licenses for the same
  433material under section 10.
  434
  435  9. Acceptance Not Required for Having Copies.
  436
  437  You are not required to accept this License in order to receive or
  438run a copy of the Program.  Ancillary propagation of a covered work
  439occurring solely as a consequence of using peer-to-peer transmission
  440to receive a copy likewise does not require acceptance.  However,
  441nothing other than this License grants you permission to propagate or
  442modify any covered work.  These actions infringe copyright if you do
  443not accept this License.  Therefore, by modifying or propagating a
  444covered work, you indicate your acceptance of this License to do so.
  445
  446  10. Automatic Licensing of Downstream Recipients.
  447
  448  Each time you convey a covered work, the recipient automatically
  449receives a license from the original licensors, to run, modify and
  450propagate that work, subject to this License.  You are not responsible
  451for enforcing compliance by third parties with this License.
  452
  453  An "entity transaction" is a transaction transferring control of an
  454organization, or substantially all assets of one, or subdividing an
  455organization, or merging organizations.  If propagation of a covered
  456work results from an entity transaction, each party to that
  457transaction who receives a copy of the work also receives whatever
  458licenses to the work the party's predecessor in interest had or could
  459give under the previous paragraph, plus a right to possession of the
  460Corresponding Source of the work from the predecessor in interest, if
  461the predecessor has it or can get it with reasonable efforts.
  462
  463  You may not impose any further restrictions on the exercise of the
  464rights granted or affirmed under this License.  For example, you may
  465not impose a license fee, royalty, or other charge for exercise of
  466rights granted under this License, and you may not initiate litigation
  467(including a cross-claim or counterclaim in a lawsuit) alleging that
  468any patent claim is infringed by making, using, selling, offering for
  469sale, or importing the Program or any portion of it.
  470
  471  11. Patents.
  472
  473  A "contributor" is a copyright holder who authorizes use under this
  474License of the Program or a work on which the Program is based.  The
  475work thus licensed is called the contributor's "contributor version".
  476
  477  A contributor's "essential patent claims" are all patent claims
  478owned or controlled by the contributor, whether already acquired or
  479hereafter acquired, that would be infringed by some manner, permitted
  480by this License, of making, using, or selling its contributor version,
  481but do not include claims that would be infringed only as a
  482consequence of further modification of the contributor version.  For
  483purposes of this definition, "control" includes the right to grant
  484patent sublicenses in a manner consistent with the requirements of
  485this License.
  486
  487  Each contributor grants you a non-exclusive, worldwide, royalty-free
  488patent license under the contributor's essential patent claims, to
  489make, use, sell, offer for sale, import and otherwise run, modify and
  490propagate the contents of its contributor version.
  491
  492  In the following three paragraphs, a "patent license" is any express
  493agreement or commitment, however denominated, not to enforce a patent
  494(such as an express permission to practice a patent or covenant not to
  495sue for patent infringement).  To "grant" such a patent license to a
  496party means to make such an agreement or commitment not to enforce a
  497patent against the party.
  498
  499  If you convey a covered work, knowingly relying on a patent license,
  500and the Corresponding Source of the work is not available for anyone
  501to copy, free of charge and under the terms of this License, through a
  502publicly available network server or other readily accessible means,
  503then you must either (1) cause the Corresponding Source to be so
  504available, or (2) arrange to deprive yourself of the benefit of the
  505patent license for this particular work, or (3) arrange, in a manner
  506consistent with the requirements of this License, to extend the patent
  507license to downstream recipients.  "Knowingly relying" means you have
  508actual knowledge that, but for the patent license, your conveying the
  509covered work in a country, or your recipient's use of the covered work
  510in a country, would infringe one or more identifiable patents in that
  511country that you have reason to believe are valid.
  512
  513  If, pursuant to or in connection with a single transaction or
  514arrangement, you convey, or propagate by procuring conveyance of, a
  515covered work, and grant a patent license to some of the parties
  516receiving the covered work authorizing them to use, propagate, modify
  517or convey a specific copy of the covered work, then the patent license
  518you grant is automatically extended to all recipients of the covered
  519work and works based on it.
  520
  521  A patent license is "discriminatory" if it does not include within
  522the scope of its coverage, prohibits the exercise of, or is
  523conditioned on the non-exercise of one or more of the rights that are
  524specifically granted under this License.  You may not convey a covered
  525work if you are a party to an arrangement with a third party that is
  526in the business of distributing software, under which you make payment
  527to the third party based on the extent of your activity of conveying
  528the work, and under which the third party grants, to any of the
  529parties who would receive the covered work from you, a discriminatory
  530patent license (a) in connection with copies of the covered work
  531conveyed by you (or copies made from those copies), or (b) primarily
  532for and in connection with specific products or compilations that
  533contain the covered work, unless you entered into that arrangement,
  534or that patent license was granted, prior to 28 March 2007.
  535
  536  Nothing in this License shall be construed as excluding or limiting
  537any implied license or other defenses to infringement that may
  538otherwise be available to you under applicable patent law.
  539
  540  12. No Surrender of Others' Freedom.
  541
  542  If conditions are imposed on you (whether by court order, agreement or
  543otherwise) that contradict the conditions of this License, they do not
  544excuse you from the conditions of this License.  If you cannot convey a
  545covered work so as to satisfy simultaneously your obligations under this
  546License and any other pertinent obligations, then as a consequence you may
  547not convey it at all.  For example, if you agree to terms that obligate you
  548to collect a royalty for further conveying from those to whom you convey
  549the Program, the only way you could satisfy both those terms and this
  550License would be to refrain entirely from conveying the Program.
  551
  552  13. Use with the GNU Affero General Public License.
  553
  554  Notwithstanding any other provision of this License, you have
  555permission to link or combine any covered work with a work licensed
  556under version 3 of the GNU Affero General Public License into a single
  557combined work, and to convey the resulting work.  The terms of this
  558License will continue to apply to the part which is the covered work,
  559but the special requirements of the GNU Affero General Public License,
  560section 13, concerning interaction through a network will apply to the
  561combination as such.
  562
  563  14. Revised Versions of this License.
  564
  565  The Free Software Foundation may publish revised and/or new versions of
  566the GNU General Public License from time to time.  Such new versions will
  567be similar in spirit to the present version, but may differ in detail to
  568address new problems or concerns.
  569
  570  Each version is given a distinguishing version number.  If the
  571Program specifies that a certain numbered version of the GNU General
  572Public License "or any later version" applies to it, you have the
  573option of following the terms and conditions either of that numbered
  574version or of any later version published by the Free Software
  575Foundation.  If the Program does not specify a version number of the
  576GNU General Public License, you may choose any version ever published
  577by the Free Software Foundation.
  578
  579  If the Program specifies that a proxy can decide which future
  580versions of the GNU General Public License can be used, that proxy's
  581public statement of acceptance of a version permanently authorizes you
  582to choose that version for the Program.
  583
  584  Later license versions may give you additional or different
  585permissions.  However, no additional obligations are imposed on any
  586author or copyright holder as a result of your choosing to follow a
  587later version.
  588
  589  15. Disclaimer of Warranty.
  590
  591  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
  592APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
  593HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
  594OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
  595THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  596PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
  597IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
  598ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
  599
  600  16. Limitation of Liability.
  601
  602  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
  603WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
  604THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
  605GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
  606USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
  607DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
  608PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
  609EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
  610SUCH DAMAGES.
  611
  612  17. Interpretation of Sections 15 and 16.
  613
  614  If the disclaimer of warranty and limitation of liability provided
  615above cannot be given local legal effect according to their terms,
  616reviewing courts shall apply local law that most closely approximates
  617an absolute waiver of all civil liability in connection with the
  618Program, unless a warranty or assumption of liability accompanies a
  619copy of the Program in return for a fee.
  620
  621                     END OF TERMS AND CONDITIONS
  622
  623            How to Apply These Terms to Your New Programs
  624
  625  If you develop a new program, and you want it to be of the greatest
  626possible use to the public, the best way to achieve this is to make it
  627free software which everyone can redistribute and change under these terms.
  628
  629  To do so, attach the following notices to the program.  It is safest
  630to attach them to the start of each source file to most effectively
  631state the exclusion of warranty; and each file should have at least
  632the "copyright" line and a pointer to where the full notice is found.
  633
  634    <one line to give the program's name and a brief idea of what it does.>
  635    Copyright (C) <year>  <name of author>
  636
  637    This program is free software: you can redistribute it and/or modify
  638    it under the terms of the GNU General Public License as published by
  639    the Free Software Foundation, either version 3 of the License, or
  640    (at your option) any later version.
  641
  642    This program is distributed in the hope that it will be useful,
  643    but WITHOUT ANY WARRANTY; without even the implied warranty of
  644    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  645    GNU General Public License for more details.
  646
  647    You should have received a copy of the GNU General Public License
  648    along with this program.  If not, see <https://www.gnu.org/licenses/>.
  649
  650Also add information on how to contact you by electronic and paper mail.
  651
  652  If the program does terminal interaction, make it output a short
  653notice like this when it starts in an interactive mode:
  654
  655    <program>  Copyright (C) <year>  <name of author>
  656    This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
  657    This is free software, and you are welcome to redistribute it
  658    under certain conditions; type `show c' for details.
  659
  660The hypothetical commands `show w' and `show c' should show the appropriate
  661parts of the General Public License.  Of course, your program's commands
  662might be different; for a GUI interface, you would use an "about box".
  663
  664  You should also get your employer (if you work as a programmer) or school,
  665if any, to sign a "copyright disclaimer" for the program, if necessary.
  666For more information on this, and how to apply and follow the GNU GPL, see
  667<https://www.gnu.org/licenses/>.
  668
  669  The GNU General Public License does not permit incorporating your program
  670into proprietary programs.  If your program is a subroutine library, you
  671may consider it more useful to permit linking proprietary applications with
  672the library.  If this is what you want to do, use the GNU Lesser General
  673Public License instead of this License.  But first, please read
  674<https://www.gnu.org/licenses/why-not-lgpl.html>.
  

• Makefile [new file]

  1CC=cc
  2CFLAGS=-Wall -Wextra -Werror -pedantic
  3CCHECK=-I. -x c - -fsyntax-only
  4
  5install:
  6	mkdir -p /usr/local/include/
  7	sudo cp src/cdoc.h /usr/local/include/
  8
  9check: src/cdoc.h
  10	@printf '#define CDOC_IMPL\n#include "%s"' "$^" | $(CC) $(CFLAGS) $(CCHECK)
  

• README.md [new file]

  1# cdoc
  2
  3Lazy documentation parser for C
  

• src/cdoc.h [new file]

  1/*
  2 * Copyright (C) 2026 Sophie Sitzler
  3 *
  4 * This program is free software: you can redistribute it and/or modify
  5 * it under the terms of the GNU General Public License as published by
  6 * the Free Software Foundation, either version 3 of the License, or
  7 * (at your option) any later version.
  8 *
  9 * This program is distributed in the hope that it will be useful,
  10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  12 * GNU General Public License for more details.
  13 *
  14 * You should have received a copy of the GNU General Public License
  15 * along with this program. If not, see <https://www.gnu.org/licenses/>.
  16 */
  17
  18// @file cdoc.h
  19// @desc Lazy documentation parser for C
  20
  21#pragma once
  22
  23#include <stdlib.h>
  24
  25// @enum cdoc_type_t
  26// @groupdef cdoc_type_t
  27typedef enum {
  28  CDOC_TYPE_NONE     =  0,
  29  CDOC_TYPE_FILE     =  1,
  30  CDOC_TYPE_IMPL     =  2,
  31  CDOC_TYPE_TYPE     =  3,
  32  CDOC_TYPE_INCLUDE  =  4,
  33  CDOC_TYPE_MACRO    =  5,
  34  CDOC_TYPE_VAR      =  6,
  35  CDOC_TYPE_ENUM     =  7,
  36  CDOC_TYPE_STRUCT   =  8,
  37  CDOC_TYPE_UNION    =  9,
  38  CDOC_TYPE_FUNCTION = 10,
  39  __CDOC_TYPE_COUNT  = 11,
  40} cdoc_type_t;
  41
  42// @struct cdoc_ref_t
  43// @groupdef cdoc_ref_t
  44typedef struct {
  45  cdoc_type_t type;
  46  char *symbol;
  47  char *description;
  48  char *signature;
  49  char *obsolete;
  50  char *note;
  51  char *ret;
  52  size_t line;
  53  bool is_internal;
  54  char **param_list;
  55  size_t param_list_len;
  56  char *groupdef;
  57  char *group;
  58} cdoc_ref_t;
  59
  60// @struct cdoc_t
  61// @groupdef cdoc_t
  62typedef struct {
  63  cdoc_ref_t *ref_list;
  64  size_t ref_list_len;
  65} cdoc_t;
  66
  67// @macro CDOC_REF_INIT
  68// @group cdoc_ref_t
  69#define CDOC_REF_INIT (cdoc_ref_t) { CDOC_TYPE_NONE, NULL, NULL, NULL, NULL, NULL, NULL, 0,  false, NULL, 0, NULL, NULL }
  70
  71// @macro CDOC_INIT
  72// @group cdoc_t
  73#define CDOC_INIT (cdoc_t) { NULL, 0 }
  74
  75// @func cdoc_type_str
  76// @group cdoc_type_t
  77const char* cdoc_type_str(cdoc_type_t type);
  78
  79// @func cdoc_type_name
  80// @group cdoc_type_t
  81const char* cdoc_type_name(cdoc_type_t type);
  82
  83// @func cdoc_is_doc
  84bool cdoc_is_doc(char *line);
  85
  86// @func cdoc_symbol_get
  87char *cdoc_symbol_get(char *line);
  88
  89// @func cdoc_parse_desc
  90char *cdoc_parse_desc(char *value);
  91
  92// @func cdoc_parse
  93// @group cdoc_t
  94cdoc_t cdoc_parse(char *content);
  95
  96// @func cdoc_free
  97// @group cdoc_t
  98void cdoc_free(cdoc_t *self);
  99
  100#ifdef CDOC_IMPL
  101
  102// @include <buf.h>
  103#include <buf.h>
  104
  105// @impl cdoc_type_str
  106const char* cdoc_type_str(cdoc_type_t type) {
  107  switch (type) {
  108    case __CDOC_TYPE_COUNT:
  109    case CDOC_TYPE_NONE:
  110      return NULL;
  111    case CDOC_TYPE_FILE:
  112      return "file";
  113    case CDOC_TYPE_IMPL:
  114      return "impl";
  115    case CDOC_TYPE_TYPE:
  116      return "type";
  117    case CDOC_TYPE_INCLUDE:
  118      return "include";
  119    case CDOC_TYPE_MACRO:
  120      return "macro";
  121    case CDOC_TYPE_VAR:
  122      return "var";
  123    case CDOC_TYPE_ENUM:
  124      return "enum";
  125    case CDOC_TYPE_STRUCT:
  126      return "struct";
  127    case CDOC_TYPE_UNION:
  128      return "union";
  129    case CDOC_TYPE_FUNCTION:
  130      return "func";
  131  }
  132  return NULL;
  133}
  134
  135// @impl cdoc_type_name
  136const char* cdoc_type_name(cdoc_type_t type) {
  137  switch (type) {
  138    case __CDOC_TYPE_COUNT:
  139    case CDOC_TYPE_NONE:
  140      return NULL;
  141    case CDOC_TYPE_FILE:
  142      return "file";
  143    case CDOC_TYPE_IMPL:
  144      return "impl";
  145    case CDOC_TYPE_TYPE:
  146      return "type";
  147    case CDOC_TYPE_INCLUDE:
  148      return "include";
  149    case CDOC_TYPE_MACRO:
  150      return "macro";
  151    case CDOC_TYPE_VAR:
  152      return "variable";
  153    case CDOC_TYPE_ENUM:
  154      return "enum";
  155    case CDOC_TYPE_STRUCT:
  156      return "struct";
  157    case CDOC_TYPE_UNION:
  158      return "union";
  159    case CDOC_TYPE_FUNCTION:
  160      return "function";
  161  }
  162  return NULL;
  163}
  164
  165// @impl cdoc_escape_str
  166char *cdoc_escape_str(char *value) {
  167  if (value == NULL) return NULL;
  168  buf_t buf= BUF_NULL;
  169  buf_write(&buf, value);
  170  buf_repall(&buf, "&", "&amp;");
  171  buf_repall(&buf, "<", "&lt;");
  172  buf_repall(&buf, ">", "&gt;");
  173  buf_repall(&buf, "\"", "&quot;");
  174  buf_repall(&buf, "'", "&apos;");
  175  buf_write_len(&buf, "\0", 1);
  176  return (char *) buf.bytes;
  177}
  178
  179// @impl cdoc_parse
  180char *cdoc_parse_desc(char *value) {
  181  if (value == NULL) return NULL;
  182  buf_t buf = BUF_NULL;
  183  size_t len = strlen(value);
  184  size_t set = 0;
  185  for (size_t i = 0; i < len; i++) {
  186    char c = value[i];
  187    if (c == '{') {
  188      buf_write_len(&buf, value + set, i - set);
  189      set = i + 1;
  190    }
  191    if (c == '}') {
  192      buf_write(&buf, "<a href=\"#");
  193      buf_write_len(&buf, value + set, i - set);
  194      buf_write(&buf, "\">");
  195      buf_write_len(&buf, value + set, i - set);
  196      buf_write(&buf, "</a>");
  197      set = i + 1;
  198    }
  199  }
  200  if (set < len) {
  201      buf_write_len(&buf, value + set, len - set);
  202  }
  203  buf_write_len(&buf, "\0", 1);
  204  return (char *) buf.bytes;
  205}
  206
  207// @impl cdoc_is_doc
  208bool cdoc_is_doc(char *line) {
  209  return strncmp(line, "// @", 4) == 0;
  210}
  211
  212// @impl cdoc_symbol_get
  213char *cdoc_symbol_get(char *line) {
  214  if (cdoc_is_doc(line)) {
  215    char *op = line + 4;
  216    for (size_t i = 0; i < __CDOC_TYPE_COUNT; i++) {
  217      cdoc_type_t type = (cdoc_type_t) i;
  218      if (type == CDOC_TYPE_NONE) {
  219        continue;
  220      }
  221      if (type == CDOC_TYPE_FILE) {
  222        continue;
  223      }
  224      const char *str = cdoc_type_str(type);
  225      if (str && strncmp(op, str, strlen(str)) == 0) {
  226        char *value = strstr(op, " ") + 1;
  227        if (value) {
  228          size_t offset = value - op;
  229          size_t value_len = strlen(line) - offset - 4;
  230          return strndup(value, value_len);
  231        }
  232      }
  233    }
  234  }
  235  return NULL;
  236}
  237
  238// @impl cdoc_parse
  239cdoc_t cdoc_parse(char *content) {
  240  cdoc_t doc = CDOC_INIT;
  241  size_t i = 0;
  242  size_t ln = 0;
  243  size_t sol = 0;
  244  size_t ln_sig = 0;
  245  bool is_doc = false;
  246  bool is_signature = false;
  247  cdoc_ref_t ref = CDOC_REF_INIT;
  248  size_t content_len = strlen(content);
  249  while (i < content_len) {
  250    char c = content[i];
  251    if (c == '\n') {
  252      size_t ln_len = i - sol;
  253      char *line = content + sol;
  254      if (strncmp(line, "// @", 4) == 0) {
  255        is_doc = true;
  256        bool is_op = false;
  257        char *op = line + 4;
  258        for (size_t i = 0; i < __CDOC_TYPE_COUNT; i++) {
  259          cdoc_type_t type = (cdoc_type_t) i;
  260          const char *str = cdoc_type_str(type);
  261          if (str && strncmp(op, str, strlen(str)) == 0) {
  262            ref.type = type;
  263            is_op = true;
  264            break;
  265          }
  266        }
  267        if (is_op) {
  268          char *value = strstr(op, " ") + 1;
  269          if (value) {
  270            size_t offset = value - op;
  271            size_t value_len = ln_len - offset - 4;
  272            ref.symbol = strndup(value, value_len);
  273          }
  274        }
  275        if (strncmp(op, "desc", 4) == 0) {
  276          char *value = strstr(op, " ") + 1;
  277          if (value) {
  278            size_t offset = value - op;
  279            size_t value_len = ln_len - offset - 4;
  280            ref.description = strndup(value, value_len);
  281          }
  282        }
  283        if (strncmp(op, "obsolete", 8) == 0) {
  284          char *value = strstr(op, " ") + 1;
  285          if (value) {
  286            size_t offset = value - op;
  287            size_t value_len = ln_len - offset - 4;
  288            ref.obsolete = strndup(value, value_len);
  289          }
  290        }
  291        if (strncmp(op, "note", 4) == 0) {
  292          char *value = strstr(op, " ") + 1;
  293          if (value) {
  294            size_t offset = value - op;
  295            size_t value_len = ln_len - offset - 4;
  296            ref.note = strndup(value, value_len);
  297          }
  298        }
  299        if (strncmp(op, "return", 6) == 0) {
  300          char *value = strstr(op, " ") + 1;
  301          if (value) {
  302            size_t offset = value - op;
  303            size_t value_len = ln_len - offset - 4;
  304            ref.ret = strndup(value, value_len);
  305          }
  306        }
  307        if (strncmp(op, "internal", 8) == 0) {
  308          ref.is_internal = true;
  309        }
  310        if (strncmp(op, "param", 5) == 0) {
  311          char *value = strstr(op, " ") + 1;
  312          if (value) {
  313            ref.param_list = realloc(ref.param_list, sizeof(char *) * (ref.param_list_len + 1));
  314            size_t offset = value - op;
  315            size_t value_len = ln_len - offset - 4;
  316            ref.param_list[ref.param_list_len] = strndup(value, value_len);
  317            ref.param_list_len++;
  318          }
  319        }
  320        if (strncmp(op, "groupdef", 8) == 0) {
  321          char *value = strstr(op, " ") + 1;
  322          if (value) {
  323            size_t offset = value - op;
  324            size_t value_len = ln_len - offset - 4;
  325            ref.groupdef = strndup(value, value_len);
  326          }
  327        }
  328        else if (strncmp(op, "group", 5) == 0) {
  329          char *value = strstr(op, " ") + 1;
  330          if (value) {
  331            size_t offset = value - op;
  332            size_t value_len = ln_len - offset - 4;
  333            ref.group = strndup(value, value_len);
  334          }
  335        }
  336      }
  337      else if (is_doc) {
  338        is_signature = true;
  339        is_doc = false;
  340        ref.line = ln + 1;
  341      }
  342      if (is_signature) {
  343        char *value = line;
  344        size_t value_len = ln_len;
  345        size_t signature_len = 0;
  346        if (value) {
  347          if (ref.signature) {
  348            signature_len = strlen(ref.signature);
  349          }
  350          ref.signature = realloc(ref.signature, sizeof(char) * (signature_len + value_len + 2));
  351          memcpy(ref.signature + signature_len, value, value_len);
  352          ref.signature[signature_len + value_len] = '\n';
  353          ref.signature[signature_len + value_len + 1] = '\0';
  354        }
  355        bool is_end = true;
  356        if (ref.type == CDOC_TYPE_MACRO) {
  357          if (ref.signature[strlen(ref.signature) - 2] == '\\') {
  358            is_end = false;
  359          }
  360        }
  361        if (ref.type == CDOC_TYPE_VAR) {
  362          if (ln_sig == 0 && ref.signature[strlen(ref.signature) - 2] == '{') {
  363            is_end = false;
  364          }
  365          if (ln_sig > 0 && ref.signature[signature_len] != '}') {
  366            is_end = false;
  367          }
  368        }
  369        if (ref.type == CDOC_TYPE_ENUM) {
  370          if (ref.signature[signature_len] != '}') {
  371            is_end = false;
  372          }
  373        }
  374        if (ref.type == CDOC_TYPE_STRUCT) {
  375          if (ln_sig == 0 && ref.signature[strlen(ref.signature) - 2] == '{') {
  376            is_end = false;
  377          }
  378          if (ln_sig > 0 && ref.signature[signature_len] != '}') {
  379            is_end = false;
  380          }
  381        }
  382        if (ref.type == CDOC_TYPE_UNION) {
  383          if (ref.signature[signature_len] != '}') {
  384            is_end = false;
  385          }
  386        }
  387        if (ref.type == CDOC_TYPE_FUNCTION) {
  388          if (ln_sig == 0 && ref.signature[strlen(ref.signature) - 2] == '{') {
  389            buf_t buf = BUF_NULL;
  390            buf_write(&buf, ref.signature);
  391            free(ref.signature);
  392            buf_repall(&buf, "{", "{ ... }");
  393            buf_write_len(&buf, "\0", 1);
  394            ref.signature = (char *) buf.bytes;
  395          }
  396        }
  397        ln_sig++;
  398        if (is_end) {
  399          is_signature = false;
  400          ln_sig = 0;
  401          if (ref.type != CDOC_TYPE_NONE) {
  402            doc.ref_list = realloc(doc.ref_list, sizeof(cdoc_ref_t) * (doc.ref_list_len + 1));
  403            memcpy(&doc.ref_list[doc.ref_list_len], &ref, sizeof(cdoc_ref_t));
  404            doc.ref_list_len++;
  405            ref = CDOC_REF_INIT;
  406          }
  407        }
  408      }
  409      sol = i + 1;
  410      ln++;
  411    }
  412    i++;
  413  }
  414  return doc;
  415}
  416
  417// @impl cdoc_free
  418void cdoc_free(cdoc_t *self) {
  419  for (size_t i = 0; i < self->ref_list_len; i++) {
  420    cdoc_ref_t *ref = &self->ref_list[i];
  421    if (ref->symbol) free(ref->symbol);
  422    if (ref->description) free(ref->description);
  423    if (ref->obsolete) free(ref->obsolete);
  424    if (ref->note) free(ref->note);
  425    if (ref->ret) free(ref->ret);
  426    if (ref->signature) free(ref->signature);
  427    if (ref->param_list) {
  428      for (size_t i = 0; i < ref->param_list_len; i++) {
  429        free(ref->param_list[i]);
  430      }
  431      free(ref->param_list);
  432    }
  433    if (ref->groupdef) free(ref->groupdef);
  434    if (ref->group) free(ref->group);
  435  }
  436}
  437
  438#endif // CDOC_IMPL