diff options
| -rw-r--r-- | Makefile | 184 | ||||
| -rw-r--r-- | README | 54 | ||||
| -rw-r--r-- | TODO | 28 | ||||
| -rw-r--r-- | doc/info/fdl.texinfo | 505 | ||||
| -rw-r--r-- | doc/info/gpp.texinfo | 254 | ||||
| -rw-r--r-- | gpp.1 (renamed from doc/man/gpp.1) | 138 | ||||
| -rwxr-xr-x | gpp.py (renamed from src/gpp.py) | 1 | ||||
| -rw-r--r-- | src/gpp.auto-completion | 33 | ||||
| -rw-r--r-- | tests/complex | 1 |
9 files changed, 168 insertions, 1030 deletions
@@ -1,20 +1,7 @@ -# Copying and distribution of this file, with or without modification, -# are permitted in any medium without royalty provided the copyright -# notice and this notice are preserved. This file is offered as-is, -# without any warranty. - VERSION = 1.5 PREFIX = /usr -BIN = /bin -DATA = /share -BINDIR = $(PREFIX)$(BIN) -DATADIR = $(PREFIX)$(DATA) -DOCDIR = $(DATADIR)/doc -INFODIR = $(DATADIR)/info -MANDIR = $(DATADIR)/man -MAN1DIR = $(MANDIR)/man1 -LICENSEDIR = $(DATADIR)/licenses +MANPREFIX = $(PREFIX)/share/man PKGNAME = gpp COMMAND = gpp @@ -23,169 +10,22 @@ PY = python SHEBANG = /usr$(BIN)/env $(PY) -.PHONY: default -default: cmd info shell - -.PHONY: all -all: cmd doc shell - -.PHONY: cmd -cmd: bin/gpp +all: gpp -bin/gpp: src/gpp.py - @mkdir -p bin +gpp: gpp.py env VERSION='$(VERSION)' SHEBANG='$(SHEBANG)' $(PY) "$<" < "$<" > "$@" -.PHONY: doc -doc: info pdf dvi ps - -.PHONY: info -info: bin/gpp.info -bin/%.info: obj/%.texinfo obj/fdl.texinfo - @mkdir -p bin - $(MAKEINFO) $< - mv $*.info $@ - -.PHONY: pdf -pdf: bin/gpp.pdf -bin/%.pdf: obj/%.texinfo obj/fdl.texinfo - @! test -d obj/pdf || rm -rf obj/pdf - @mkdir -p bin obj/pdf - cd obj/pdf && texi2pdf ../../"$<" < /dev/null - mv obj/pdf/$*.pdf $@ - -.PHONY: dvi -dvi: bin/gpp.dvi -bin/%.dvi: obj/%.texinfo obj/fdl.texinfo - @! test -d obj/dvi || rm -rf obj/dvi - @mkdir -p bin obj/dvi - cd obj/dvi && $(TEXI2DVI) ../../"$<" < /dev/null - mv obj/dvi/$*.dvi $@ - -.PHONY: ps -ps: bin/gpp.ps -bin/%.ps: obj/%.texinfo obj/fdl.texinfo - @! test -d obj/ps || rm -rf obj/ps - @mkdir -p bin obj/ps - cd obj/ps && texi2pdf --ps ../../"$<" < /dev/null - mv obj/ps/$*.ps $@ - -obj/gpp.texinfo: doc/info/gpp.texinfo bin/gpp - @mkdir -p obj - $(PY) bin/gpp -s '?' -D GPP=$(COMMAND) < "$<" > "$@" - -obj/fdl.texinfo: doc/info/fdl.texinfo - @mkdir -p obj - cp "$<" "$@" - -.PHONY: shell -shell: bash fish zsh - -.PHONY: bash -bash: bin/gpp.bash-completion - -.PHONY: fish -fish: bin/gpp.fish-completion - -.PHONY: zsh -zsh: bin/gpp.zsh-completion - -obj/gpp.auto-completion: src/gpp.auto-completion bin/gpp - @mkdir -p obj - cp $< $@ - $(PY) bin/gpp -s '#' -D GPP=$(COMMAND) < "$<" > "$@" - -bin/gpp.%sh-completion: obj/gpp.auto-completion - @mkdir -p bin - auto-auto-complete $*sh --output $@ --source $< - - - -.PHONY: install -install: install-core install-info install-man install-shell +install: gpp + install -dm755 -- "$(DESTDIR)$(PREFIX)/bin" + install -m755 -- gpp "$(DESTDIR)$(PREFIX)/bin/$(COMMAND)" + install -dm755 -- "$(DESTDIR)$(MANPREFIX)/man" + install -m644 -- gpp.1 "$(DESTDIR)$(MANPREFIX)/man/$(COMMAND).1" -.PHONY: install -install-all: install-core install-doc install-shell - -.PHONY: install-core -install-core: install-cmd install-license - -.PHONY: install-cmd -install-cmd: bin/gpp - install -dm755 -- "$(DESTDIR)$(BINDIR)" - install -m755 $< -- "$(DESTDIR)$(BINDIR)/$(COMMAND)" - -.PHONY: install-license -install-license: - install -dm755 -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - install -m644 COPYING LICENSE -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -.PHONY: install-doc -install-doc: install-info install-pdf install-dvi install-ps install-man - -.PHONY: install-info -install-info: bin/gpp.info - install -dm755 -- "$(DESTDIR)$(INFODIR)" - install -m644 $< -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" - -.PHONY: install-pdf -install-pdf: bin/gpp.pdf - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" - -.PHONY: install-dvi -install-dvi: bin/gpp.dvi - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" - -.PHONY: install-ps -install-ps: bin/gpp.ps - install -dm755 -- "$(DESTDIR)$(DOCDIR)" - install -m644 $< -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" - -.PHONY: install-man -install-man: doc/man/gpp.1 - install -dm755 -- "$(DESTDIR)$(MAN1DIR)" - install -m644 $< -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1" - -.PHONY: install-shell -install-shell: install-bash install-fish install-zsh - -.PHONY: install-bash -install-bash: bin/gpp.bash-completion - install -dm755 -- "$(DESTDIR)$(DATADIR)/bash-completion/completions" - install -m644 $< -- "$(DESTDIR)$(DATADIR)/bash-completion/completions/$(COMMAND)" - -.PHONY: install-fish -install-fish: bin/gpp.fish-completion - install -dm755 -- "$(DESTDIR)$(DATADIR)/fish/completions" - install -m644 $< -- "$(DESTDIR)$(DATADIR)/fish/completions/$(COMMAND).fish" - -.PHONY: install-zsh -install-zsh: bin/gpp.zsh-completion - install -dm755 -- "$(DESTDIR)$(DATADIR)/zsh/site-functions" - install -m644 $< -- "$(DESTDIR)$(DATADIR)/zsh/site-functions/_$(COMMAND)" - - - -.PHONY: uninstall uninstall: - -rm -- "$(DESTDIR)$(BINDIR)/$(COMMAND)" - -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/COPYING" - -rm -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)/LICENSE" - -rmdir -- "$(DESTDIR)$(LICENSEDIR)/$(PKGNAME)" - -rm -- "$(DESTDIR)$(INFODIR)/$(PKGNAME).info" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).pdf" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).dvi" - -rm -- "$(DESTDIR)$(DOCDIR)/$(PKGNAME).ps" - -rm -- "$(DESTDIR)$(MAN1DIR)/$(COMMAND).1" - -rm -- "$(DESTDIR)$(DATADIR)/bash-completion/completions/$(COMMAND)" - -rm -- "$(DESTDIR)$(DATADIR)/fish/completions/$(COMMAND).fish" - -rm -- "$(DESTDIR)$(DATADIR)/zsh/site-functions/_$(COMMAND)" - - + -rm -- "$(DESTDIR)$(PREFIX)/bin/$(COMMAND)" + -rm -- "$(DESTDIR)$(MANPREFIX)/man/$(COMMAND).1" -.PHONY: clean clean: - -rm -r bin obj + -rm -rf -- gpp bin obj +.PHONY: all install uninstall clean @@ -1,11 +1,12 @@ NAME gpp - Bash-based preprocessor for anything - gpp: General Preprocessor - SYNOPSIS gpp [OPTION]... +ETYMOLOGY + gpp stands for General Preprocessor. + DESCRIPTION gpp lets a developer embed directives written in GNU Bash into any text document. These directives are used @@ -36,8 +37,8 @@ DESCRIPTION uppercase you can write @{VARIABLE^^}, or @{VARIABLE,,} for lowercase. - Everything that is not preprocessing directives is - threaded as echo(1):ed lines. + Everything that is not a preprocessing directive is + echo verbatim. OPTIONS -s, --symbol SYMBOL @@ -81,6 +82,48 @@ OPTIONS Short options must be joined. The value of a flag must be in a separate argument from the flag itself. +EXAMPLES + Conditional hello world + This example only includes the "Hello world" line if + the environment variable HELLO is defined and is not + empty. + + @>if [ -z "$HELLO" ]; the + Hello world + @>fi + + Mutliline preprocessor directive + This example creates the function uppercase() that + convert lower case ASCII leters to uper case. + + @<uppercase () { + lower=qwertyuiopasdfghjklzxcvbnm + upper=QWERTYUIOPASDFGHJKLZXCVBNM + sed y/$lower/$upper/ <<<"$*" + @>} + + Inline directives + This example uses the uppercase() function above to + convert the user's username to upper case. If the user's + username is john, the code will expand to You are logged + in as JOHN. + + You are logged in as @(uppercase $USER). + + Variable expansions + In this example, if the user's username john, the code + will expand to You are logged in as john. + + You are logged in as @{USER}. + + Variable expansion with substitution + This example uses a substitution mechanism in Bash to + convert the first letter in a variable to upper case. + In this example, if the user's username john, the code + will expand to You are logged in as John. + + You are logged in as @{USER^}. + RATIONALE Programmers need more automation when we write software and documentation. An unrestricted preprocessor lets @@ -96,6 +139,3 @@ RATIONALE SEE ALSO bash(1), jpp(1), cpp(1), env(1) - - Full documentation available locally via: info '(gpp)' - @@ -1,21 +1,11 @@ -This should only used when necessary when -when a specific flag is used. - Before all lines, add 10ⁿ−1 empty lines - where n is as small as possible to retain - as line numbers but with a constant - multiple. - Then add m10ᷜ number of empty lines - at the top of the file, where k is large - and n is the number specified above. - Because of line continuations and disc - resources it is best to implement this - in gpp. +This should only used when necessary when when a specific flag is used. + Before all lines, add 10ⁿ−1 empty lines where n is as small as possible + to retain as line numbers but with a constant multiple. Then add m10ᷜ + number of empty lines at the top of the file, where k is large and n is + the number specified above. Because of line continuations and disc + resources it is best to implement this in gpp. -The option above should be aware of -line continues using a backslash at -the end of the line before the -continuation unless another flag is -used. This could either be an additional -flag or an alternative flag (uppercase +The option above should be aware of line continues using a backslash at +the end of the line before the continuation unless another flag is used. +This could either be an additional flag or an alternative flag (uppercase of the above's.) - diff --git a/doc/info/fdl.texinfo b/doc/info/fdl.texinfo deleted file mode 100644 index cb71f05..0000000 --- a/doc/info/fdl.texinfo +++ /dev/null @@ -1,505 +0,0 @@ -@c The GNU Free Documentation License. -@center Version 1.3, 3 November 2008 - -@c This file is intended to be included within another document, -@c hence no sectioning command or @node. - -@display -Copyright @copyright{} 2000, 2001, 2002, 2007, 2008 Free Software Foundation, Inc. -@uref{http://fsf.org/} - -Everyone is permitted to copy and distribute verbatim copies -of this license document, but changing it is not allowed. -@end display - -@enumerate 0 -@item -PREAMBLE - -The purpose of this License is to make a manual, textbook, or other -functional and useful document @dfn{free} in the sense of freedom: to -assure everyone the effective freedom to copy and redistribute it, -with or without modifying it, either commercially or noncommercially. -Secondarily, this License preserves for the author and publisher a way -to get credit for their work, while not being considered responsible -for modifications made by others. - -This License is a kind of ``copyleft'', which means that derivative -works of the document must themselves be free in the same sense. It -complements the GNU General Public License, which is a copyleft -license designed for free software. - -We have designed this License in order to use it for manuals for free -software, because free software needs free documentation: a free -program should come with manuals providing the same freedoms that the -software does. But this License is not limited to software manuals; -it can be used for any textual work, regardless of subject matter or -whether it is published as a printed book. We recommend this License -principally for works whose purpose is instruction or reference. - -@item -APPLICABILITY AND DEFINITIONS - -This License applies to any manual or other work, in any medium, that -contains a notice placed by the copyright holder saying it can be -distributed under the terms of this License. Such a notice grants a -world-wide, royalty-free license, unlimited in duration, to use that -work under the conditions stated herein. The ``Document'', below, -refers to any such manual or work. Any member of the public is a -licensee, and is addressed as ``you''. You accept the license if you -copy, modify or distribute the work in a way requiring permission -under copyright law. - -A ``Modified Version'' of the Document means any work containing the -Document or a portion of it, either copied verbatim, or with -modifications and/or translated into another language. - -A ``Secondary Section'' is a named appendix or a front-matter section -of the Document that deals exclusively with the relationship of the -publishers or authors of the Document to the Document's overall -subject (or to related matters) and contains nothing that could fall -directly within that overall subject. (Thus, if the Document is in -part a textbook of mathematics, a Secondary Section may not explain -any mathematics.) The relationship could be a matter of historical -connection with the subject or with related matters, or of legal, -commercial, philosophical, ethical or political position regarding -them. - -The ``Invariant Sections'' are certain Secondary Sections whose titles -are designated, as being those of Invariant Sections, in the notice -that says that the Document is released under this License. If a -section does not fit the above definition of Secondary then it is not -allowed to be designated as Invariant. The Document may contain zero -Invariant Sections. If the Document does not identify any Invariant -Sections then there are none. - -The ``Cover Texts'' are certain short passages of text that are listed, -as Front-Cover Texts or Back-Cover Texts, in the notice that says that -the Document is released under this License. A Front-Cover Text may -be at most 5 words, and a Back-Cover Text may be at most 25 words. - -A ``Transparent'' copy of the Document means a machine-readable copy, -represented in a format whose specification is available to the -general public, that is suitable for revising the document -straightforwardly with generic text editors or (for images composed of -pixels) generic paint programs or (for drawings) some widely available -drawing editor, and that is suitable for input to text formatters or -for automatic translation to a variety of formats suitable for input -to text formatters. A copy made in an otherwise Transparent file -format whose markup, or absence of markup, has been arranged to thwart -or discourage subsequent modification by readers is not Transparent. -An image format is not Transparent if used for any substantial amount -of text. A copy that is not ``Transparent'' is called ``Opaque''. - -Examples of suitable formats for Transparent copies include plain -ASCII without markup, Texinfo input format, La@TeX{} input -format, SGML or XML using a publicly available -DTD, and standard-conforming simple HTML, -PostScript or PDF designed for human modification. Examples -of transparent image formats include PNG, XCF and -JPG. Opaque formats include proprietary formats that can be -read and edited only by proprietary word processors, SGML or -XML for which the DTD and/or processing tools are -not generally available, and the machine-generated HTML, -PostScript or PDF produced by some word processors for -output purposes only. - -The ``Title Page'' means, for a printed book, the title page itself, -plus such following pages as are needed to hold, legibly, the material -this License requires to appear in the title page. For works in -formats which do not have any title page as such, ``Title Page'' means -the text near the most prominent appearance of the work's title, -preceding the beginning of the body of the text. - -The ``publisher'' means any person or entity that distributes copies -of the Document to the public. - -A section ``Entitled XYZ'' means a named subunit of the Document whose -title either is precisely XYZ or contains XYZ in parentheses following -text that translates XYZ in another language. (Here XYZ stands for a -specific section name mentioned below, such as ``Acknowledgements'', -``Dedications'', ``Endorsements'', or ``History''.) To ``Preserve the Title'' -of such a section when you modify the Document means that it remains a -section ``Entitled XYZ'' according to this definition. - -The Document may include Warranty Disclaimers next to the notice which -states that this License applies to the Document. These Warranty -Disclaimers are considered to be included by reference in this -License, but only as regards disclaiming warranties: any other -implication that these Warranty Disclaimers may have is void and has -no effect on the meaning of this License. - -@item -VERBATIM COPYING - -You may copy and distribute the Document in any medium, either -commercially or noncommercially, provided that this License, the -copyright notices, and the license notice saying this License applies -to the Document are reproduced in all copies, and that you add no other -conditions whatsoever to those of this License. You may not use -technical measures to obstruct or control the reading or further -copying of the copies you make or distribute. However, you may accept -compensation in exchange for copies. If you distribute a large enough -number of copies you must also follow the conditions in section 3. - -You may also lend copies, under the same conditions stated above, and -you may publicly display copies. - -@item -COPYING IN QUANTITY - -If you publish printed copies (or copies in media that commonly have -printed covers) of the Document, numbering more than 100, and the -Document's license notice requires Cover Texts, you must enclose the -copies in covers that carry, clearly and legibly, all these Cover -Texts: Front-Cover Texts on the front cover, and Back-Cover Texts on -the back cover. Both covers must also clearly and legibly identify -you as the publisher of these copies. The front cover must present -the full title with all words of the title equally prominent and -visible. You may add other material on the covers in addition. -Copying with changes limited to the covers, as long as they preserve -the title of the Document and satisfy these conditions, can be treated -as verbatim copying in other respects. - -If the required texts for either cover are too voluminous to fit -legibly, you should put the first ones listed (as many as fit -reasonably) on the actual cover, and continue the rest onto adjacent -pages. - -If you publish or distribute Opaque copies of the Document numbering -more than 100, you must either include a machine-readable Transparent -copy along with each Opaque copy, or state in or with each Opaque copy -a computer-network location from which the general network-using -public has access to download using public-standard network protocols -a complete Transparent copy of the Document, free of added material. -If you use the latter option, you must take reasonably prudent steps, -when you begin distribution of Opaque copies in quantity, to ensure -that this Transparent copy will remain thus accessible at the stated -location until at least one year after the last time you distribute an -Opaque copy (directly or through your agents or retailers) of that -edition to the public. - -It is requested, but not required, that you contact the authors of the -Document well before redistributing any large number of copies, to give -them a chance to provide you with an updated version of the Document. - -@item -MODIFICATIONS - -You may copy and distribute a Modified Version of the Document under -the conditions of sections 2 and 3 above, provided that you release -the Modified Version under precisely this License, with the Modified -Version filling the role of the Document, thus licensing distribution -and modification of the Modified Version to whoever possesses a copy -of it. In addition, you must do these things in the Modified Version: - -@enumerate A -@item -Use in the Title Page (and on the covers, if any) a title distinct -from that of the Document, and from those of previous versions -(which should, if there were any, be listed in the History section -of the Document). You may use the same title as a previous version -if the original publisher of that version gives permission. - -@item -List on the Title Page, as authors, one or more persons or entities -responsible for authorship of the modifications in the Modified -Version, together with at least five of the principal authors of the -Document (all of its principal authors, if it has fewer than five), -unless they release you from this requirement. - -@item -State on the Title page the name of the publisher of the -Modified Version, as the publisher. - -@item -Preserve all the copyright notices of the Document. - -@item -Add an appropriate copyright notice for your modifications -adjacent to the other copyright notices. - -@item -Include, immediately after the copyright notices, a license notice -giving the public permission to use the Modified Version under the -terms of this License, in the form shown in the Addendum below. - -@item -Preserve in that license notice the full lists of Invariant Sections -and required Cover Texts given in the Document's license notice. - -@item -Include an unaltered copy of this License. - -@item -Preserve the section Entitled ``History'', Preserve its Title, and add -to it an item stating at least the title, year, new authors, and -publisher of the Modified Version as given on the Title Page. If -there is no section Entitled ``History'' in the Document, create one -stating the title, year, authors, and publisher of the Document as -given on its Title Page, then add an item describing the Modified -Version as stated in the previous sentence. - -@item -Preserve the network location, if any, given in the Document for -public access to a Transparent copy of the Document, and likewise -the network locations given in the Document for previous versions -it was based on. These may be placed in the ``History'' section. -You may omit a network location for a work that was published at -least four years before the Document itself, or if the original -publisher of the version it refers to gives permission. - -@item -For any section Entitled ``Acknowledgements'' or ``Dedications'', Preserve -the Title of the section, and preserve in the section all the -substance and tone of each of the contributor acknowledgements and/or -dedications given therein. - -@item -Preserve all the Invariant Sections of the Document, -unaltered in their text and in their titles. Section numbers -or the equivalent are not considered part of the section titles. - -@item -Delete any section Entitled ``Endorsements''. Such a section -may not be included in the Modified Version. - -@item -Do not retitle any existing section to be Entitled ``Endorsements'' or -to conflict in title with any Invariant Section. - -@item -Preserve any Warranty Disclaimers. -@end enumerate - -If the Modified Version includes new front-matter sections or -appendices that qualify as Secondary Sections and contain no material -copied from the Document, you may at your option designate some or all -of these sections as invariant. To do this, add their titles to the -list of Invariant Sections in the Modified Version's license notice. -These titles must be distinct from any other section titles. - -You may add a section Entitled ``Endorsements'', provided it contains -nothing but endorsements of your Modified Version by various -parties---for example, statements of peer review or that the text has -been approved by an organization as the authoritative definition of a -standard. - -You may add a passage of up to five words as a Front-Cover Text, and a -passage of up to 25 words as a Back-Cover Text, to the end of the list -of Cover Texts in the Modified Version. Only one passage of -Front-Cover Text and one of Back-Cover Text may be added by (or -through arrangements made by) any one entity. If the Document already -includes a cover text for the same cover, previously added by you or -by arrangement made by the same entity you are acting on behalf of, -you may not add another; but you may replace the old one, on explicit -permission from the previous publisher that added the old one. - -The author(s) and publisher(s) of the Document do not by this License -give permission to use their names for publicity for or to assert or -imply endorsement of any Modified Version. - -@item -COMBINING DOCUMENTS - -You may combine the Document with other documents released under this -License, under the terms defined in section 4 above for modified -versions, provided that you include in the combination all of the -Invariant Sections of all of the original documents, unmodified, and -list them all as Invariant Sections of your combined work in its -license notice, and that you preserve all their Warranty Disclaimers. - -The combined work need only contain one copy of this License, and -multiple identical Invariant Sections may be replaced with a single -copy. If there are multiple Invariant Sections with the same name but -different contents, make the title of each such section unique by -adding at the end of it, in parentheses, the name of the original -author or publisher of that section if known, or else a unique number. -Make the same adjustment to the section titles in the list of -Invariant Sections in the license notice of the combined work. - -In the combination, you must combine any sections Entitled ``History'' -in the various original documents, forming one section Entitled -``History''; likewise combine any sections Entitled ``Acknowledgements'', -and any sections Entitled ``Dedications''. You must delete all -sections Entitled ``Endorsements.'' - -@item -COLLECTIONS OF DOCUMENTS - -You may make a collection consisting of the Document and other documents -released under this License, and replace the individual copies of this -License in the various documents with a single copy that is included in -the collection, provided that you follow the rules of this License for -verbatim copying of each of the documents in all other respects. - -You may extract a single document from such a collection, and distribute -it individually under this License, provided you insert a copy of this -License into the extracted document, and follow this License in all -other respects regarding verbatim copying of that document. - -@item -AGGREGATION WITH INDEPENDENT WORKS - -A compilation of the Document or its derivatives with other separate -and independent documents or works, in or on a volume of a storage or -distribution medium, is called an ``aggregate'' if the copyright -resulting from the compilation is not used to limit the legal rights -of the compilation's users beyond what the individual works permit. -When the Document is included in an aggregate, this License does not -apply to the other works in the aggregate which are not themselves -derivative works of the Document. - -If the Cover Text requirement of section 3 is applicable to these -copies of the Document, then if the Document is less than one half of -the entire aggregate, the Document's Cover Texts may be placed on -covers that bracket the Document within the aggregate, or the -electronic equivalent of covers if the Document is in electronic form. -Otherwise they must appear on printed covers that bracket the whole -aggregate. - -@item -TRANSLATION - -Translation is considered a kind of modification, so you may -distribute translations of the Document under the terms of section 4. -Replacing Invariant Sections with translations requires special -permission from their copyright holders, but you may include -translations of some or all Invariant Sections in addition to the -original versions of these Invariant Sections. You may include a -translation of this License, and all the license notices in the -Document, and any Warranty Disclaimers, provided that you also include -the original English version of this License and the original versions -of those notices and disclaimers. In case of a disagreement between -the translation and the original version of this License or a notice -or disclaimer, the original version will prevail. - -If a section in the Document is Entitled ``Acknowledgements'', -``Dedications'', or ``History'', the requirement (section 4) to Preserve -its Title (section 1) will typically require changing the actual -title. - -@item -TERMINATION - -You may not copy, modify, sublicense, or distribute the Document -except as expressly provided under this License. Any attempt -otherwise to copy, modify, sublicense, or distribute it is void, and -will automatically terminate your rights under this License. - -However, if you cease all violation of this License, then your license -from a particular copyright holder is reinstated (a) provisionally, -unless and until the copyright holder explicitly and finally -terminates your license, and (b) permanently, if the copyright holder -fails to notify you of the violation by some reasonable means prior to -60 days after the cessation. - -Moreover, your license from a particular copyright holder is -reinstated permanently if the copyright holder notifies you of the -violation by some reasonable means, this is the first time you have -received notice of violation of this License (for any work) from that -copyright holder, and you cure the violation prior to 30 days after -your receipt of the notice. - -Termination of your rights under this section does not terminate the -licenses of parties who have received copies or rights from you under -this License. If your rights have been terminated and not permanently -reinstated, receipt of a copy of some or all of the same material does -not give you any rights to use it. - -@item -FUTURE REVISIONS OF THIS LICENSE - -The Free Software Foundation may publish new, revised versions -of the GNU Free Documentation License from time to time. Such new -versions will be similar in spirit to the present version, but may -differ in detail to address new problems or concerns. See -@uref{http://www.gnu.org/copyleft/}. - -Each version of the License is given a distinguishing version number. -If the Document specifies that a particular numbered version of this -License ``or any later version'' applies to it, you have the option of -following the terms and conditions either of that specified version or -of any later version that has been published (not as a draft) by the -Free Software Foundation. If the Document does not specify a version -number of this License, you may choose any version ever published (not -as a draft) by the Free Software Foundation. If the Document -specifies that a proxy can decide which future versions of this -License can be used, that proxy's public statement of acceptance of a -version permanently authorizes you to choose that version for the -Document. - -@item -RELICENSING - -``Massive Multiauthor Collaboration Site'' (or ``MMC Site'') means any -World Wide Web server that publishes copyrightable works and also -provides prominent facilities for anybody to edit those works. A -public wiki that anybody can edit is an example of such a server. A -``Massive Multiauthor Collaboration'' (or ``MMC'') contained in the -site means any set of copyrightable works thus published on the MMC -site. - -``CC-BY-SA'' means the Creative Commons Attribution-Share Alike 3.0 -license published by Creative Commons Corporation, a not-for-profit -corporation with a principal place of business in San Francisco, -California, as well as future copyleft versions of that license -published by that same organization. - -``Incorporate'' means to publish or republish a Document, in whole or -in part, as part of another Document. - -An MMC is ``eligible for relicensing'' if it is licensed under this -License, and if all works that were first published under this License -somewhere other than this MMC, and subsequently incorporated in whole -or in part into the MMC, (1) had no cover texts or invariant sections, -and (2) were thus incorporated prior to November 1, 2008. - -The operator of an MMC Site may republish an MMC contained in the site -under CC-BY-SA on the same site at any time before August 1, 2009, -provided the MMC is eligible for relicensing. - -@end enumerate - -@page -@heading ADDENDUM: How to use this License for your documents - -To use this License in a document you have written, include a copy of -the License in the document and put the following copyright and -license notices just after the title page: - -@smallexample -@group - Copyright (C) @var{year} @var{your name}. - Permission is granted to copy, distribute and/or modify this document - under the terms of the GNU Free Documentation License, Version 1.3 - or any later version published by the Free Software Foundation; - with no Invariant Sections, no Front-Cover Texts, and no Back-Cover - Texts. A copy of the license is included in the section entitled ``GNU - Free Documentation License''. -@end group -@end smallexample - -If you have Invariant Sections, Front-Cover Texts and Back-Cover Texts, -replace the ``with@dots{}Texts.''@: line with this: - -@smallexample -@group - with the Invariant Sections being @var{list their titles}, with - the Front-Cover Texts being @var{list}, and with the Back-Cover Texts - being @var{list}. -@end group -@end smallexample - -If you have Invariant Sections without Cover Texts, or some other -combination of the three, merge those two alternatives to suit the -situation. - -If your document contains nontrivial examples of program code, we -recommend releasing these examples in parallel under your choice of -free software license, such as the GNU General Public License, -to permit their use in free software. - -@c Local Variables: -@c ispell-local-pdict: "ispell-dict" -@c End: diff --git a/doc/info/gpp.texinfo b/doc/info/gpp.texinfo deleted file mode 100644 index fcc566a..0000000 --- a/doc/info/gpp.texinfo +++ /dev/null @@ -1,254 +0,0 @@ -\input texinfo @c -*-texinfo-*- - -@c %**start of header -@setfilename gpp.info -@settitle ?{GPP} -@afourpaper -@documentencoding UTF-8 -@documentlanguage en -@finalout -@c %**end of header - - -@dircategory Development -@direntry -* ?{GPP}: (?{GPP}). Bash-based preprocessor for anything -@end direntry - - -@copying -Copyright @copyright{} 2013, 2015 Mattias Andrée - -@quotation -Permission is granted to copy, distribute and/or modify this document -under the terms of the GNU Free Documentation License, Version 1.3 or -any later version published by the Free Software Foundation; with no -Invariant Sections, with no Front-Cover Texts, and with no Back-Cover -Texts. A copy of the license is included in the section entitled -``GNU Free Documentation License''. -@end quotation -@end copying - -@ifnottex -@node Top -@top gpp -- Bash-based preprocessor for anything -@insertcopying -@end ifnottex - -@titlepage -@title gpp -@subtitle Bash-based preprocessor for anything -@author by Mattias Andrée (maandree) - -@page -@vskip 0pt plus 1filll -@insertcopying -@end titlepage - -@contents - - - -@menu -* Overview:: Brief overview of @command{?{GPP}}. -* Invoking:: Invoking @command{?{GPP}}. -* Syntax:: Syntax of @command{?{GPP}}. -* GNU Free Documentation License:: Copying and sharing this manual. -@end menu - - - -@node Overview -@chapter Overview - -General Preprocessor (gpp) is a preprocessor -based on GNU Bash that can be used for anything. - -By default an at-sign (@@) is used as prefix -for preprocessor directives, but any single -single character can be used. If the prefix -symbol is directly followed by itself it results -to the symbol itself rather than a preprocessor -directive. - -A file written with gpp contains, text that -can be in any format, gpp does not care how -it is formatted, and lines written in GNU Bash -that are executed and termine which part of -the text should be keept and how it should -be repeated. A line can also be partially -written in GNU Bash to modify it. Each line -that is not in GNU Bash as actually treated -as a echo instruction. - -The preprocessor will try to keep the lines in -the output files in the same position as in -the source files. This will however stop to -work if the processor directives includes -loops or instructions that returns multiple -lines. - - - -@node Invoking -@chapter Invoking - -Syntax for invoking @command{?{GPP}}: -@command{?{GPP} [options...]} - -Short options must not be joined and -the value for a flag must be in a -separate argument from the flag itself. - -For example, @option{--symbol=X} is not allowed, -but @option{--symbol X} is. - -@table @option -@item -s -@itemx --symbol -Set the prefix symbol for preprocessor directives. (Default: @@) - -@item -e -@itemx --encoding -Set the encoding of file. - -@item -n -@itemx --iterations -Number of iterations to run the preprocessing in. (Default: 1) - -@item -u -@itemx --unshebang -Blank out the shebang line. Notice that the line is not removed, -it is just cleared. You can use a shebang line make to gpp -preprocess the file when executed. - -If @option{--unshebang} is used twice, the second line in the -file will be moved up to the top of the file and the initial -shebang line will be removed. A blank line will be inserted -after the new top line will be added to keep the line numbers -in the output file as near as possible to the line numbers -in the input file. The intension of this option is that you -can have two shebang lines, one on the first line for preprocessing -when the file is executed, and one shebang line on the second -line for output file. - -@item -i -@itemx --input -Set the input file. (Default: /dev/stdin) - -@item -o -@itemx --output -Set the output file. (Default: /dev/stdout) - -@item -f -@itemx --file -Set both input file and output file. - -@item -D -@itemx --export -Declare a environment variable. The syntax -@code{NAME=VALUE} is used for the argument, -but if the argument does not include an -equals sign the value 1 will be used. - -@item -v -@itemx --version -Print program name and version and exit. - -@item -c -@itemx --copying -Print copyright notice and exit. - -@end table - - - -@node Syntax -@chapter Syntax - -To create a preprocess directive, begin the -line with @code{@@>}. For example, the follow -code will only keep the `Hello world' line -if the environment variable @var{HELLO} is -defined and is not empty. - -@example -@@>[ -z "$HELLO" ] && -Hello world -@end example - -If you want to write a mutliline preprocessor -directive you can begin the first line with -@code{@@<} and begin the last line with -@code{@@>}, instead of having each line start -with @code{@@>}. For example, if you want -to create a preprocess function to make a -ASCII text uppercase you can write: - -@example -@@<uppercase () @{ - lower=qwertyuiopasdfghjklzxcvbnm - upper=QWERTYUIOPASDFGHJKLZXCVBNM - sed y/$lower/$upper/ <<<"$*" -@@>@} -@end example - -Now assume that you have this @command{uppercase} -preprocessor function defined on the top of a -document. Also assume that you are logged in -as the user `twilight' and therefor have the -environment variable @var{USER} set to `twilight'. - -If you in the document, below the definition -of @command{uppercase}, insert the line - -@example -Your are logged in as @@(uppercase $USER). -@end example - -After preprocessing it will say - -@example -Your are logged in as TWILIGHT. -@end example - -@@(...) can be used inline. It executes a -command that can either be defined as a -preprocessor function or be an external program. -Preprocossor directives cannot be used inside -it, everything in it is in GNU Bash. - -@@@{...@} is another inline preprocessor directive, -you can put the name of a preprocessor variable -or environment variable inside it to get the -variable's value. For example, if you are -logged in as `twilight' - -@example -Your are logged in as @@@{USER@}. -@end example - -@noindent -will after preprocessing say - -@example -Your are logged in as twilight. -@end example - -@noindent -@command{gpp} supports all modifications to the -result that Bash does. For example, if you want -the value to be uppercased you can write - -@example -Your are logged in as @@@{USER^^@}. -@end example - - - -@node GNU Free Documentation License -@appendix GNU Free Documentation License -@include fdl.texinfo - -@bye - @@ -1,11 +1,14 @@ -.TH GPP 1 GPP +.TH GPP 1 gpp .SH NAME gpp - Bash-based preprocessor for anything -.PP -gpp: General Preprocessor + .SH SYNOPSIS -.BR gpp +.R gpp .RI [ OPTION ]... + +.SH ETYMOLOGY +gpp stands for General Preprocessor. + .SH DESCRIPTION .B gpp lets a developer embed directives written in @@ -15,23 +18,35 @@ to automate the writting of parts of the document. .PP The preprocessing directives start with a symbol (or text string) specified by the developer. By default -this symbol is \fB@\fP (at). +this symbol is +.B @ +(at). .PP -Any line starting with \fB@<\fP (where \fB@\fP is -the selected symbol for preprocessing directives) -or \fB@>\fP, or is between a line starting with -\fB@<\fP and a line starting with \fB@>\fP, is parsed -as a line, written in +Any line starting with +.B @< (where +.B @ +is the selected symbol for preprocessing directives) or +.BR @> , +or is between a line starting with +.B @ +and a line starting with +.BR @> , +is parsed as a line, written in .BR bash (1), -that is executed during preprocessing. A \fB@<\fP -line must have an associated \fB@>\fP line somewhere -after it, all lines between them are parsed as -preprocessing directives. A \fB@>\fP does however -not need an associated \fB@<\fP line somewhere before -it, making \fB@>\fP suitable for single line directives. +that is executed during preprocessing. A +.B @< +line must have an associated +.B @> +line somewhere after it, all lines between them are +parsed as preprocessing directives. A +.B @> +does however not need an associated +.B @< +line somewhere before it, making +.B @> +suitable for single line directives. .PP -Preprocessing directives can also be inline. For this, -use +Preprocessing directives can also be inline. For this, use .BI @( COMMAND ) where .I COMMAND @@ -54,10 +69,9 @@ or .BI @{ VARIABLE ,,} for lowercase. .PP -Everything that is not preprocessing directives is -threaded as -.BR echo (1):ed -lines. +Everything that is not a preprocessing directive is +echo verbatim. + .SH OPTIONS .TP .BR \-s ,\ \-\-symbol \ \fISYMBOL\fP @@ -100,6 +114,69 @@ Print copyright notice and exit. .PP Short options must be joined. The value of a flag must be in a separate argument from the flag itself. + +.SH EXAMPLES +.SS Conditional hello world +This example only includes the +.RB \(dq "Hello world" \(dq +line if the environment variable +.B HELLO +is defined and is not empty. +.PP +.nf +@>if [ -z "$HELLO" ]; the +Hello world +@>fi +.fi + +.SS Mutliline preprocessor directive +This example creates the function +.BR uppercase () +that convert lower case ASCII leters to uper case. +.PP +.nf +@<uppercase () { + lower=qwertyuiopasdfghjklzxcvbnm + upper=QWERTYUIOPASDFGHJKLZXCVBNM + sed y/$lower/$upper/ <<<"$*" +@>} +.fi + +.SS Inline directives +This example uses the +.BR uppercase () +function above to convert the user's username +to upper case. If the user's username is +.BR john , +the code will expand to +.B You are logged in as JOHN. +.PP +.nf +You are logged in as @(uppercase $USER). +.fi + +.SS Variable expansions +In this example, if the user's username +.BR john , +the code will expand to +.B You are logged in as john. +.PP +.nf +You are logged in as @{USER}. +.fi + +.SS Variable expansion with substitution +This example uses a substitution mechanism in Bash to +convert the first letter in a variable to upper case. +In this example, if the user's username +.BR john , +the code will expand to +.B You are logged in as John. +.PP +.nf +You are logged in as @{USER^}. +.fi + .SH RATIONALE Programmers need more automation when we write software and documentation. An unrestricted preprocessor lets @@ -112,24 +189,9 @@ of the work. C is one of the few languages that includes a preprocessor, some times it is not enough; and all languages need preprocessors. + .SH "SEE ALSO" .BR bash (1), .BR jpp (1), .BR cpp (1), .BR env (1) -.PP -Full documentation available locally via: info \(aq(gpp)\(aq -.SH AUTHORS -Principal author, Mattias Andrée. See the COPYING file for the full -list of authors. -.SH LICENSE -Copyright \(co 2013, 2014, 2015, 2017 Mattias Andrée -.br -License GPLv3+: GNU GPL version 3 or later <http://gnu.org/licenses/gpl.html>. -.br -This is free software: you are free to change and redistribute it. -.br -There is NO WARRANTY, to the extent permitted by law. -.SH BUGS -Please report bugs to https://github.com/maandree/passcheck/issues or to -maandree@member.fsf.org @@ -253,4 +253,3 @@ data = bytes(linejoin(data)) with open(output_file, 'wb') as file: file.write(data) file.flush() - diff --git a/src/gpp.auto-completion b/src/gpp.auto-completion deleted file mode 100644 index fdfb967..0000000 --- a/src/gpp.auto-completion +++ /dev/null @@ -1,33 +0,0 @@ -(#{GPP} - (argumented (options -s --symbol) (complete --symbol) (arg SYMBOL) (files -0) - (desc 'Set the prefix symbol for preprocessor directives')) - - (argumented (options -e --encoding) (complete --encoding) (arg ENCODING) (files -0) (suggest encoding) - (desc 'Select encoding of the file')) - (suggestion encoding (verbatim UTF-8)) - - (argumented (options -n --iterations) (complete --iterations) (arg N) (files -0) - (desc 'Select the number of times to perform the preprocessing recursively')) - - (unargumented (options -u --unshebang) (complete --unshebang) - (desc 'Clear the shebang line, twice to delete it')) - - (argumented (options -i --input) (complete --input) (arg FILE) (files -f) - (desc 'Select file to process')) - - (argumented (options -i --output) (complete --output) (arg FILE) (files -f) - (desc 'Select output file')) - - (argumented (options -f --file) (complete --file) (arg FILE) (files -r) - (desc 'Select file to both process and store the output')) - - (argumented (options -D --export) (complete --export) (arg NAME=VALUE) (files -0) - (desc 'Set environment variable')) - - (unargumented (options -v --version) (complete --version) - (desc 'Print program name and version and exit')) - - (unargumented (options -c --copying) (complete --copying) - (desc 'Print copyright notice and exit')) -) - diff --git a/tests/complex b/tests/complex index 2f6af5b..ce5cf1d 100644 --- a/tests/complex +++ b/tests/complex @@ -4,4 +4,3 @@ '@{h}ello @(echo `echo 'W'`"o$(echo $(echo r))"'ld!')' @('$()$()') - |