-p added

.gitignore

@@ -1,3 +1,5 @@
 documentation.aux
 documentation.log
+documentation.out
+documentation.toc
 example.lst

README.md

@@ -5,7 +5,7 @@ Author
 : Jonathan P. Spratte
 
 Version
-: 1.0
+: 1.0.1
 
 Copyright (c)
 : 2019 Jonathan P. Spratte

documentation.tex

@@ -10,14 +10,14 @@
 \makeatother
 
 \title{\py}
-\author{Jonathan P.\@ Spratte}
+\subtitle{1.0.1}
+\author{Jonathan P.\@ Spratte\thanks{\texttt{jspratte(at)yahoo.de}}}
 \date{\today}
 
 \usepackage{listings}
 \usepackage{listings-ext}
 \usepackage{enumitem}
 \usepackage{xcolor}
-\usepackage[]{url}
 %% call listings-extx.py with:
 %%   ./listings-extx.py -o example.lst example.c
 \input{example.lst}
@@ -42,8 +42,11 @@
     ,keywordstyle=[3]{\bfseries\color{blue!50!black}}
   }
 
+\usepackage[colorlinks]{hyperref}
+
 \begin{document}
 \maketitle
+\tableofcontents
 
 \section{Introduction}
 \py\ was created because I liked the idea of the \pkg{listings-ext} package and
@@ -55,7 +58,7 @@ This script does extract lines and line ranges from a source file and outputs
 those ranges with \cs{lstdef}-calls so that \pkg{listings-ext} can understand
 them. Line ranges are marked using formatted comments.
 
-This script require Python3 to be installed, it contains a shebang
+This script requires Python3 to be installed, it contains a shebang
 \lstinline|#!/bin/python3| which should run the correct Python version on most
 Unix systems on which Python3 is installed. However this doesn't work on Windows
 where you'll have to call it with \lstinline|python listings-extx.py|.
@@ -127,6 +130,10 @@ few command line parameters to control its behaviour, the order doesn't matter,
 parameters can be given before or after file names. Arguments to parameters are
 always mandatory. The output will be printed
 to \texttt{stdout} by default.
+\begin{lstlisting}[style=regex, keywordstyle={}]
+listings-extx.py [<options>] <filename> ...
+\end{lstlisting}
+\meta{options} can be any number of:
 \begin{description}[font=-\ttfamily]
   \item[a, --abs-path]
     use the absolute file path instead of the path given as argument.
@@ -138,6 +145,14 @@ to \texttt{stdout} by default.
     to match C-style comments this would be \lstinline{'//|/\*'}.
   \item[h]
     print a short help and exit
+  \item[o, --output-file=\meta{output filename}]
+    if this argument is present, the output will be written into a file
+    \meta{output filename}; if \meta{output filename} is an empty string, the
+    output is redirected into a file with a basename corresponding to the name
+    of the current directory with the extension '.lst'.
+  \item[p, --prefix=\meta{string}]
+    prefix every identifier with this \meta{string}, if both this and the
+    \texttt{--basename} option is used, the prefix is added before the basename.
   \item[S, --silent]
     If used the program doesn't report which files to process and where to write
     the output to.
@@ -152,11 +167,6 @@ to \texttt{stdout} by default.
       \item['none']
         no spaces are allowed before the start of the comment
     \end{description}
-  \item[o, --output-file=\meta{output filename}]
-    if this argument is present, the output will be written into a file
-    \meta{output filename}; if \meta{output filename} is an empty string, the
-    output is redirected into a file with a basename corresponding to the name
-    of the current directory with the extension '.lst'.
   \item[v, --version]
     Print some version information and exit
 \end{description}
@@ -173,6 +183,12 @@ listings-extx.py -o example.lst example.c
 The following is the output in \file{example.lst}:
 \lstinputlisting[language=TeX]{example.lst}
 
+\section{Bugreports}
+If you find any bugs, you can report them via mail (see the footnote on the
+first page; please use a descriptive subject). This script is hosted at
+\url{https://gitlass.de/jonathan/listings-extx.py}, you could report bugs there,
+too, but chances are you don't have an account there.
+
 \begin{thebibliography}{9}
   \bibitem{lstext}
     Jobst Hoffmann,

listings-extx.py

@@ -2,7 +2,7 @@
 
 ## listings-extx.py -- Some program to get named entries for listings-ext 
 ## Author: Jonathan P. Spratte <j.spratte(at)yahoo.de>
-## Version: 1.0
+## Version: 1.0.1
 ## Keywords: LaTeX, listings
 ## Copyright (C) 2019 Jonathan P. Spratte <j.spratte(at)yahoo.de>
 ##-------------------------------------------------------------------
@@ -85,7 +85,7 @@ class Object(object): # hacky way to have a nice parameters structure {{{
     pass# }}}
 
 def print_version():# {{{
-    print("listings-extx.py v1.0")
+    print("listings-extx.py v1.0.1")
     print("Copyright (C) 2019 Jonathan P. Spratte")
     print_wrapped(
             "License GPLv3+: GNU GPL version 3 or later "
@@ -134,6 +134,8 @@ def arg_parse(name,argv,parameters):# {{{
             parameters.comment_char = arg
         elif opt in ("-o", "--output-file"):
             parameters.output = arg
+        elif opt in ("-p", "--prefix"):
+            parameters.prefix = arg
         elif opt in ("-S", "--silent"):
             parameters.silent = True
         elif opt in ("-s", "--spaces"):
@@ -180,39 +182,44 @@ def give_help(name,err=0):# {{{
             "prefix every identifier with the processed file's basename "
             + "followed by a period."
             )
-    print_opt("-c, --comment-char <regex>",
+    print_opt("-c, --comment-char=<regex>",
             "use <regex> as the comment starting character. For "
             + "instance to match C-style comments this would be '//|/\*'."
         )
     print_opt("-h", "print this help and exit")
+    print_opt("-o, --output-file=<output filename>",
+            "if this argument is present, the output "
+            + "will be written into a file <output filename>; "
+            + "if <output filename> is an empty string, the output is "
+            + "redirected into a file with a basename corresponding to the "
+            + "name of the current directory with the extension '.lst'"
+        )
+    print_opt("-p, --prefix=<string>",
+            "prefix every identifier with this <string>, if both this and the "
+            + "'--basename' option is used, the prefix is added before the "
+            + "basename."
+            )
     print_opt("-S, --silent",
             "If used the program doesn't report which files to process and "
             + "where to write the output to."
             )
-    print_opt("-s, --spaces <choice>",
+    print_opt("-s, --spaces=<choice>",
             "Defines how spaces at the begin of the line are handled. "
             + "<choice> must be one of:"
             )
     print_opt("'must'",
             "(default) there must be spaces before the start of the "
             + "comment",
-            indent="\t\t", moreindent="        "
+            indent="\t\t", moreindent="    "
             )
     print_opt("'can'",
             "there can be spaces before the start of the comment",
-            indent="\t\t", moreindent="\t\t    "
+            indent="\t\t", moreindent="    "
             )
     print_opt("'none'",
             "no spaces are allowed before the start of the comment",
-            indent="\t\t", moreindent="\t\t    "
+            indent="\t\t", moreindent="    "
             )
-    print_opt("-o, --output-file <output filename>",
-            "if this argument is present, the output "
-            + "will be written into a file <output filename>; "
-            + "if <output filename> is an empty string, the output is "
-            + "redirected into a file with a basename corresponding to the "
-            + "name of the current directory with the extension '.lst'"
-        )
     print_opt("-v, --version", "Print some version information and exit")
     quit(err)# }}}
 
@@ -322,9 +329,9 @@ def process_file(fname, parameters):# {{{
     be = [ (name, lines) for name, lines in be.items() ]
     return (fname, ba + bj + be)# }}}
 
-def write_code_point(f, code_point, out, basename):# {{{
+def write_code_point(f, code_point, out, prefix, basename):# {{{
     b = Path(f).stem + "." if basename else ""
-    out.write("\\lstdef{"+b+code_point[0]+"}{"+f+"}{"+code_point[1]+"}\n")# }}}
+    out.write("\\lstdef{"+p+b+code_point[0]+"}{"+f+"}{"+code_point[1]+"}\n")# }}}
 
 def main(name,args):# {{{
     parameters = Object()
@@ -335,6 +342,7 @@ def main(name,args):# {{{
     parameters.comment_char = False
     parameters.basename = False
     parameters.no_spaces = 0
+    parameters.prefix = ""
     arg_parse(name,args,parameters)
     if len(parameters.files) == 0:
         eprint("No input files given")
@@ -371,7 +379,7 @@ def main(name,args):# {{{
     if not needs_close: print()
     for f, cc in code_points:
         for c in cc:
-            write_code_point(f, c, out, parameters.basename)
+            write_code_point(f, c, out, parameters.prefix, parameters.basename)
     if needs_close: out.close()# }}}
 
 if __name__ == "__main__":