Add doc
This commit is contained in:
NIIBE Yutaka
7
.gitignore
vendored
Normal file
7
.gitignore
vendored
Normal file
@@ -0,0 +1,7 @@
|
||||
example-cdc/.dep
|
||||
example-cdc/board.h
|
||||
example-cdc/build
|
||||
example-led/.dep
|
||||
example-led/board.h
|
||||
example-led/build
|
||||
doc/chopstx.info
|
||||
25
README
25
README
@@ -1,19 +1,38 @@
|
||||
Chopstx - Threads and only Threads
|
||||
Version 0.00
|
||||
2013-06-XX
|
||||
2013-08-21
|
||||
Niibe Yutaka
|
||||
Flying Stone Technology
|
||||
|
||||
What's Chopstx?
|
||||
===============
|
||||
|
||||
Chopstx is a RT thread library for ARM Cortex-M3, specifically,
|
||||
Chopstx is an RT thread library for ARM Cortex-M3, specifically,
|
||||
STM32F103.
|
||||
|
||||
While most RTOSes come with many features, drivers, and stacks,
|
||||
Chopstx just offers a RT thread library.
|
||||
|
||||
With Chopstx, interrupt handling is also done by a thread. This
|
||||
enables coherent code to allow us ease of maintenance.
|
||||
enables coherent code for ease of maintenance.
|
||||
|
||||
|
||||
License
|
||||
=======
|
||||
|
||||
It is distributed under GNU General Public Licence version 3 or later
|
||||
(GPLv3+), with additional permission. Please see COPYING and
|
||||
EXCEPTION.
|
||||
|
||||
|
||||
Example code
|
||||
============
|
||||
|
||||
We have two examples in this distribution, LED blinker and
|
||||
USB CDC-ACM function. You can build it like:
|
||||
|
||||
$ cd example-cdc
|
||||
$ ln -s ../board/board-olimex-stm32-h103.h board.h
|
||||
$ make
|
||||
|
||||
--
|
||||
|
||||
13
doc/README
Normal file
13
doc/README
Normal file
@@ -0,0 +1,13 @@
|
||||
The GDOC script is taken from:
|
||||
|
||||
http://git.savannah.gnu.org/cgit/libidn.git/plain/doc/gdoc
|
||||
|
||||
and then modified %highlights_texinfo to use @var for parameters.
|
||||
|
||||
The file 'chopstx-api.texi' is generated by:
|
||||
|
||||
$ ./gdoc -texinfo ../chopstx.c >chopstx-api.texi
|
||||
|
||||
Then, we generate chopstx.info by:
|
||||
|
||||
$ makeinfo -o chopstx.info chopstx.texi
|
||||
191
doc/chopstx-api.texi
Normal file
191
doc/chopstx-api.texi
Normal file
@@ -0,0 +1,191 @@
|
||||
@subheading chx_fatal
|
||||
@anchor{chx_fatal}
|
||||
@deftypefun {void} {chx_fatal} (uint32_t @var{err_code})
|
||||
@var{err_code}: Error code
|
||||
|
||||
When it detects a coding error, this function will be called to
|
||||
stop further execution of code. It never returns.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_create
|
||||
@anchor{chopstx_create}
|
||||
@deftypefun {chopstx_t} {chopstx_create} (uint32_t @var{flags_and_prio}, uint32_t @var{stack_addr}, size_t @var{stack_size}, voidfunc @var{thread_entry}, void * @var{arg})
|
||||
@var{flags_and_prio}: Flags and priority
|
||||
|
||||
@var{stack_addr}: Stack address
|
||||
|
||||
@var{stack_size}: Size of stack
|
||||
|
||||
@var{thread_entry}: Entry function of new thread
|
||||
|
||||
@var{arg}: Argument to the thread entry function
|
||||
|
||||
Create a thread.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_usec_wait_var
|
||||
@anchor{chopstx_usec_wait_var}
|
||||
@deftypefun {void} {chopstx_usec_wait_var} (uint32_t * @var{var})
|
||||
@var{var}: Pointer to usec
|
||||
|
||||
Sleep for micro second specified by @var{var}.
|
||||
Another thread can clear @var{var} on condition (to avoid this thread going into sleep).
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_usec_wait
|
||||
@anchor{chopstx_usec_wait}
|
||||
@deftypefun {void} {chopstx_usec_wait} (uint32_t @var{usec})
|
||||
@var{usec}: number of micro seconds
|
||||
|
||||
Sleep for @var{usec}.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_mutex_init
|
||||
@anchor{chopstx_mutex_init}
|
||||
@deftypefun {void} {chopstx_mutex_init} (chopstx_mutex_t * @var{mutex})
|
||||
@var{mutex}: Mutex
|
||||
|
||||
Initialize @var{mutex}.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_mutex_lock
|
||||
@anchor{chopstx_mutex_lock}
|
||||
@deftypefun {void} {chopstx_mutex_lock} (chopstx_mutex_t * @var{mutex})
|
||||
@var{mutex}: Mutex
|
||||
|
||||
Lock @var{mutex}.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_mutex_unlock
|
||||
@anchor{chopstx_mutex_unlock}
|
||||
@deftypefun {void} {chopstx_mutex_unlock} (chopstx_mutex_t * @var{mutex})
|
||||
@var{mutex}: Mutex
|
||||
|
||||
Unlock @var{mutex}.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_cond_init
|
||||
@anchor{chopstx_cond_init}
|
||||
@deftypefun {void} {chopstx_cond_init} (chopstx_cond_t * @var{cond})
|
||||
@var{cond}: Condition variable
|
||||
|
||||
Initialize @var{cond}.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_cond_wait
|
||||
@anchor{chopstx_cond_wait}
|
||||
@deftypefun {void} {chopstx_cond_wait} (chopstx_cond_t * @var{cond}, chopstx_mutex_t * @var{mutex})
|
||||
@var{cond}: Condition variable
|
||||
|
||||
@var{mutex}: Associated mutex
|
||||
|
||||
Wait for @var{cond} with @var{mutex}.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_cond_signal
|
||||
@anchor{chopstx_cond_signal}
|
||||
@deftypefun {void} {chopstx_cond_signal} (chopstx_cond_t * @var{cond})
|
||||
@var{cond}: Condition variable
|
||||
|
||||
Wake up a thread waiting on @var{cond}.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_cond_broadcast
|
||||
@anchor{chopstx_cond_broadcast}
|
||||
@deftypefun {void} {chopstx_cond_broadcast} (chopstx_cond_t * @var{cond})
|
||||
@var{cond}: Condition Variable
|
||||
|
||||
Wake up all thread winting on @var{cond}.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_claim_irq
|
||||
@anchor{chopstx_claim_irq}
|
||||
@deftypefun {void} {chopstx_claim_irq} (chopstx_intr_t * @var{intr}, uint8_t @var{irq_num})
|
||||
@var{intr}: Pointer to INTR structure
|
||||
|
||||
@var{irq_num}: IRQ Number (hardware specific)
|
||||
|
||||
Claim interrupt @var{intr} with @var{irq_num} for this thread.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_release_irq
|
||||
@anchor{chopstx_release_irq}
|
||||
@deftypefun {void} {chopstx_release_irq} (chopstx_intr_t * @var{intr0})
|
||||
@var{intr0}: Interrupt request to be unregistered
|
||||
|
||||
Release the interrupt request specified by @var{intr0}.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_intr_wait
|
||||
@anchor{chopstx_intr_wait}
|
||||
@deftypefun {void} {chopstx_intr_wait} (chopstx_intr_t * @var{intr})
|
||||
@var{intr}: Pointer to INTR structure
|
||||
|
||||
Wait for the interrupt @var{intr} to be occured.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_cleanup_push
|
||||
@anchor{chopstx_cleanup_push}
|
||||
@deftypefun {void} {chopstx_cleanup_push} (struct chx_cleanup * @var{clp})
|
||||
@var{clp}: Pointer to clean-up structure
|
||||
|
||||
Register a clean-up structure.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_cleanup_pop
|
||||
@anchor{chopstx_cleanup_pop}
|
||||
@deftypefun {void} {chopstx_cleanup_pop} (int @var{execute})
|
||||
@var{execute}: Execute the clen-up function on release
|
||||
|
||||
Unregister a clean-up structure. When @var{execute} is non-zero, the
|
||||
clean-up will be executed.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_exit
|
||||
@anchor{chopstx_exit}
|
||||
@deftypefun {void} {chopstx_exit} (void * @var{retval})
|
||||
@var{retval}: Return value (to be caught by a joining thread)
|
||||
|
||||
Calling this function terminates the execution of thread, after
|
||||
calling clean up functions. If the calling thread still holds
|
||||
mutexes, they will be released. If the calling thread claiming
|
||||
IRQ, it will be released, too. This function never returns.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_join
|
||||
@anchor{chopstx_join}
|
||||
@deftypefun {void} {chopstx_join} (chopstx_t @var{thd}, void ** @var{ret})
|
||||
@var{thd}: Thread to wait
|
||||
|
||||
@var{ret}: Pointer to void * to store return value
|
||||
|
||||
Waits for the thread of @var{thd} to terminate.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_wakeup_usec_wait
|
||||
@anchor{chopstx_wakeup_usec_wait}
|
||||
@deftypefun {void} {chopstx_wakeup_usec_wait} (chopstx_t @var{thd})
|
||||
@var{thd}: Thread to be awakened
|
||||
|
||||
Canceling the timer, wakup the sleeping thread for it.
|
||||
No return value.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_cancel
|
||||
@anchor{chopstx_cancel}
|
||||
@deftypefun {void} {chopstx_cancel} (chopstx_t @var{thd})
|
||||
@var{thd}: Thread to be canceled
|
||||
|
||||
This function requests a cancellation th the thread @var{thd}.
|
||||
No return value.
|
||||
@end deftypefun
|
||||
|
||||
@subheading chopstx_testcancel
|
||||
@anchor{chopstx_testcancel}
|
||||
@deftypefun {void} {chopstx_testcancel} ( @var{void})
|
||||
|
||||
Calling chopstx_testcancel creates a cancellation point.
|
||||
No return value. If the thread is canceled, this function
|
||||
does not return.
|
||||
@end deftypefun
|
||||
|
||||
116
doc/chopstx.texi
Normal file
116
doc/chopstx.texi
Normal file
@@ -0,0 +1,116 @@
|
||||
\input texinfo @c -*-texinfo-*-
|
||||
@c %**start of header
|
||||
@setfilename chopstx.info
|
||||
@set VERSION 0.00
|
||||
@settitle Chopstx Reference Manual
|
||||
@c Unify some of the indices.
|
||||
@syncodeindex tp fn
|
||||
@syncodeindex pg fn
|
||||
@c %**end of header
|
||||
@copying
|
||||
This manual is for Chopstx (version @value{VERSION}).
|
||||
|
||||
@noindent
|
||||
Copyright @copyright{} 2013 Flying Stone Technology @*
|
||||
|
||||
@quotation
|
||||
Permission is granted to copy, distribute and/or modify this document
|
||||
under the terms of the GNU General Public License as published by the
|
||||
Free Software Foundation; either version 3 of the License, or (at your
|
||||
option) any later version. The text of the license can be found in the
|
||||
section entitled ``Copying''.
|
||||
@end quotation
|
||||
@end copying
|
||||
|
||||
|
||||
@c ********************************************
|
||||
|
||||
@dircategory Development
|
||||
@direntry
|
||||
* chopstx: (chopstx). Chopstx, the thread library for embedded system.
|
||||
@end direntry
|
||||
|
||||
@c
|
||||
@c Titlepage
|
||||
@c
|
||||
@setchapternewpage odd
|
||||
@titlepage
|
||||
@title Chopstx Reference Manual
|
||||
@subtitle Version @value{VERSION}
|
||||
@author NIIBE Yutaka (@email{gniibe@@fsij.org})
|
||||
|
||||
@page
|
||||
@vskip 0pt plus 1filll
|
||||
@insertcopying
|
||||
@end titlepage
|
||||
|
||||
@ifnothtml
|
||||
@summarycontents
|
||||
@contents
|
||||
@page
|
||||
@end ifnothtml
|
||||
|
||||
@ifnottex
|
||||
@node Top
|
||||
@top Chopstx, The Thread Library
|
||||
@insertcopying
|
||||
@end ifnottex
|
||||
|
||||
|
||||
@menu
|
||||
* Introduction:: What is Chopstx.
|
||||
* API:: API.
|
||||
|
||||
Appendix
|
||||
|
||||
* Copying:: The GNU General Public License says how you
|
||||
can copy and share the program.
|
||||
|
||||
Indexes
|
||||
|
||||
* Concept Index:: Index of concepts and programs.
|
||||
* Function and Data Index:: Index of functions, variables and data types.
|
||||
|
||||
@end menu
|
||||
|
||||
@ifhtml
|
||||
@page
|
||||
@summarycontents
|
||||
@contents
|
||||
@end ifhtml
|
||||
|
||||
@c ********************************************
|
||||
@node Introduction
|
||||
@chapter Introduction
|
||||
|
||||
Chopstx is an RT thread library for ARM Cortex-M3, specifically,
|
||||
STM32F103.
|
||||
|
||||
While most RTOSes come with many features, drivers, and stacks,
|
||||
Chopstx just offers a RT thread library.
|
||||
|
||||
With Chopstx, interrupt handling is also done by a thread. This
|
||||
enables coherent code for ease of maintenance.
|
||||
|
||||
|
||||
@node API
|
||||
@chapter API
|
||||
|
||||
@include chopstx-api.texi
|
||||
|
||||
|
||||
@c ********************************************
|
||||
|
||||
@include gpl.texi
|
||||
|
||||
@node Concept Index
|
||||
@unnumbered Concept Index
|
||||
|
||||
@printindex cp
|
||||
|
||||
@node Function and Data Index
|
||||
@unnumbered Function and Data Index
|
||||
|
||||
@printindex fn
|
||||
|
||||
@bye
|
||||
912
doc/gdoc
Executable file
912
doc/gdoc
Executable file
@@ -0,0 +1,912 @@
|
||||
eval '(exit $?0)' && eval 'exec perl -S "$0" ${1+"$@"}'
|
||||
& eval 'exec perl -S "$0" $argv:q'
|
||||
if 0;
|
||||
# Generate documentation from source code.
|
||||
|
||||
## Copyright (c) 2002-2013 Simon Josefsson
|
||||
## added -texinfo, -listfunc, -pkg-name
|
||||
## man page revamp
|
||||
## various improvements
|
||||
## Copyright (c) 2001, 2002 Nikos Mavrogiannopoulos
|
||||
## added -tex
|
||||
## Copyright (c) 1998 Michael Zucchi
|
||||
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# This will read a C source code file and scan for embedded comments
|
||||
# in the style of gnome comments (+minor extensions - see below).
|
||||
|
||||
# usage:
|
||||
# gdoc [ -docbook | -html | -text | -man | -tex | -texinfo | -listfunc ]
|
||||
# [ -sourceversion verno ] [ -include file | -includefuncprefix ]
|
||||
# [ -bugsto address ] [ -pkg-name packagename ]
|
||||
# [ -seeinfo infonode ] [ -copyright notice ] [ -verbatimcopying ]
|
||||
# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
|
||||
#
|
||||
# Set output format using one of -docbook, -html, -text, -man, -tex,
|
||||
# -texinfo, or -listfunc. Default is man.
|
||||
#
|
||||
# -sourceversion
|
||||
# Version number for source code, e.g. '1.0.4'. Used in 'man' headers.
|
||||
# Defaults to using current date.
|
||||
#
|
||||
# -include FILE
|
||||
# For man pages, mention #include <FILE.h> in the synopsis.
|
||||
#
|
||||
# -includefuncprefix
|
||||
# For man pages, mention a #include <FILE.h> in the synopsis.
|
||||
# The FILE derived from the function prefix. For example, a
|
||||
# function gss_init_sec_context will generate an include
|
||||
# statement of #include <gss.h>.
|
||||
#
|
||||
# -bugsto address
|
||||
# For man pages, include a section about reporting bugs and mention
|
||||
# the given e-mail address, e.g 'bug-libidn@gnu.org'.
|
||||
#
|
||||
# -pkg-name packagename
|
||||
# For man pages when -bugsto is used, also include help URLs to the
|
||||
# the project's home page. For example, "GNU Libidn".
|
||||
#
|
||||
# -seeinfo infonode
|
||||
# For man pages, include a section that point to an info manual
|
||||
# for more information.
|
||||
#
|
||||
# -copyright notice
|
||||
# For man pages, include a copyright section with the given
|
||||
# notice after a preamble. Use, e.g., '2002, 2003 Simon Josefsson'.
|
||||
#
|
||||
# -verbatimcopying
|
||||
# For man pages, and when the -copyright parameter is used,
|
||||
# add a licensing statement that say verbatim copying is permitted.
|
||||
#
|
||||
# -function funcname
|
||||
# If set, then only generate documentation for the given function(s). All
|
||||
# other functions are ignored.
|
||||
#
|
||||
# c files - list of 'c' files to process
|
||||
#
|
||||
# All output goes to stdout, with errors to stderr.
|
||||
|
||||
#
|
||||
# format of comments.
|
||||
# In the following table, (...)? signifies optional structure.
|
||||
# (...)* signifies 0 or more structure elements
|
||||
# /**
|
||||
# * function_name(:)? (- short description)?
|
||||
# (* @parameterx: (description of parameter x)?)*
|
||||
# (* a blank line)?
|
||||
# * (Description:)? (Description of function)?
|
||||
# * (Section header: (section description)? )*
|
||||
# (*)?*/
|
||||
#
|
||||
# So .. the trivial example would be:
|
||||
#
|
||||
# /**
|
||||
# * my_function
|
||||
# **/
|
||||
#
|
||||
# If the Description: header tag is ommitted, then there must be a blank line
|
||||
# after the last parameter specification.
|
||||
# e.g.
|
||||
# /**
|
||||
# * my_function - does my stuff
|
||||
# * @my_arg: its mine damnit
|
||||
# *
|
||||
# * Does my stuff explained.
|
||||
# */
|
||||
#
|
||||
# or, could also use:
|
||||
# /**
|
||||
# * my_function - does my stuff
|
||||
# * @my_arg: its mine damnit
|
||||
# * Description: Does my stuff explained.
|
||||
# */
|
||||
# etc.
|
||||
#
|
||||
# All descriptions can be multiline, apart from the short function description.
|
||||
#
|
||||
# All descriptive text is further processed, scanning for the following special
|
||||
# patterns, which are highlighted appropriately.
|
||||
#
|
||||
# 'funcname()' - function
|
||||
# '$ENVVAR' - environmental variable OBSOLETE (?)
|
||||
# '#struct_name' - name of a structure
|
||||
# '@parameter' - name of a parameter
|
||||
# '%CONST' - name of a constant.
|
||||
|
||||
#
|
||||
# Extensions for LaTeX:
|
||||
#
|
||||
# 1. the symbol '->' will be replaced with a rightarrow
|
||||
# 2. x^y with ${x}^{y}$.
|
||||
# 3. xxx\: with xxx:
|
||||
|
||||
use POSIX qw(strftime);
|
||||
|
||||
# match expressions used to find embedded type information
|
||||
$type_constant = "\\\%(\\w+)";
|
||||
$type_func = "(\\w+\\(\\))";
|
||||
$type_param = "\\\@(\\w+)";
|
||||
$type_struct = "\\\#(\\w+)";
|
||||
$type_env = "(\\\$\\w+)";
|
||||
|
||||
|
||||
# Output conversion substitutions.
|
||||
# One for each output format
|
||||
|
||||
# these work fairly well
|
||||
%highlights_html = ( $type_constant, "<i>\$1</i>",
|
||||
$type_func, "<b>\$1</b>",
|
||||
$type_struct, "<i>\$1</i>",
|
||||
$type_param, "<tt><b>\$1</b></tt>" );
|
||||
$blankline_html = "<p>";
|
||||
|
||||
%highlights_texinfo = ( $type_constant, "\\\@code{\$1}",
|
||||
$type_func, "\\\@code{\$1}",
|
||||
$type_struct, "\\\@code{\$1}",
|
||||
$type_param, "\\\@var{\$1}" );
|
||||
$blankline_texinfo = "";
|
||||
|
||||
%highlights_tex = ( $type_constant, "{\\\\it \$1}",
|
||||
$type_func, "{\\\\bf \$1}",
|
||||
$type_struct, "{\\\\it \$1}",
|
||||
$type_param, "{\\\\bf \$1}" );
|
||||
$blankline_tex = "\\\\";
|
||||
|
||||
# sgml, docbook format
|
||||
%highlights_sgml = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
|
||||
$type_func, "<function>\$1</function>",
|
||||
$type_struct, "<structname>\$1</structname>",
|
||||
$type_env, "<envar>\$1</envar>",
|
||||
$type_param, "<parameter>\$1</parameter>" );
|
||||
$blankline_sgml = "</para><para>\n";
|
||||
|
||||
# these are pretty rough
|
||||
%highlights_man = ( $type_constant, "\\\\fB\$1\\\\fP",
|
||||
$type_func, "\\\\fB\$1\\\\fP",
|
||||
$type_struct, "\\\\fB\$1\\\\fP",
|
||||
$type_param, "\\\\fI\$1\\\\fP" );
|
||||
$blankline_man = "";
|
||||
|
||||
# text-mode
|
||||
%highlights_text = ( $type_constant, "\$1",
|
||||
$type_func, "\$1",
|
||||
$type_struct, "\$1",
|
||||
$type_param, "\$1" );
|
||||
$blankline_text = "";
|
||||
|
||||
|
||||
sub usage {
|
||||
print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -tex | -texinfo -listfunc ]\n";
|
||||
print " [ -sourceversion verno ] [ -include file | -includefuncprefix ]\n";
|
||||
print " [ -bugsto address ] [ -seeinfo infonode ] [ -copyright notice]\n";
|
||||
print " [ -verbatimcopying ] [ -pkg-name packagename ]\n";
|
||||
print " [ -function funcname [ -function funcname ...] ]\n";
|
||||
print " c source file(s) > outputfile\n";
|
||||
exit 1;
|
||||
}
|
||||
|
||||
# read arguments
|
||||
if ($#ARGV==-1) {
|
||||
usage();
|
||||
}
|
||||
|
||||
$verbose = 0;
|
||||
$output_mode = "man";
|
||||
%highlights = %highlights_man;
|
||||
$blankline = $blankline_man;
|
||||
$modulename = "API Documentation";
|
||||
$sourceversion = strftime "%Y-%m-%d", localtime;
|
||||
$function_only = 0;
|
||||
while ($ARGV[0] =~ m/^-(.*)/) {
|
||||
$cmd = shift @ARGV;
|
||||
if ($cmd eq "-html") {
|
||||
$output_mode = "html";
|
||||
%highlights = %highlights_html;
|
||||
$blankline = $blankline_html;
|
||||
} elsif ($cmd eq "-man") {
|
||||
$output_mode = "man";
|
||||
%highlights = %highlights_man;
|
||||
$blankline = $blankline_man;
|
||||
} elsif ($cmd eq "-tex") {
|
||||
$output_mode = "tex";
|
||||
%highlights = %highlights_tex;
|
||||
$blankline = $blankline_tex;
|
||||
} elsif ($cmd eq "-texinfo") {
|
||||
$output_mode = "texinfo";
|
||||
%highlights = %highlights_texinfo;
|
||||
$blankline = $blankline_texinfo;
|
||||
} elsif ($cmd eq "-text") {
|
||||
$output_mode = "text";
|
||||
%highlights = %highlights_text;
|
||||
$blankline = $blankline_text;
|
||||
} elsif ($cmd eq "-docbook") {
|
||||
$output_mode = "sgml";
|
||||
%highlights = %highlights_sgml;
|
||||
$blankline = $blankline_sgml;
|
||||
} elsif ($cmd eq "-listfunc") {
|
||||
$output_mode = "listfunc";
|
||||
} elsif ($cmd eq "-module") { # not needed for sgml, inherits from calling document
|
||||
$modulename = shift @ARGV;
|
||||
} elsif ($cmd eq "-sourceversion") {
|
||||
$sourceversion = shift @ARGV;
|
||||
} elsif ($cmd eq "-include") {
|
||||
$include = shift @ARGV;
|
||||
} elsif ($cmd eq "-includefuncprefix") {
|
||||
$includefuncprefix = 1;
|
||||
} elsif ($cmd eq "-bugsto") {
|
||||
$bugsto = shift @ARGV;
|
||||
} elsif ($cmd eq "-pkg-name") {
|
||||
$pkgname = shift @ARGV;
|
||||
} elsif ($cmd eq "-copyright") {
|
||||
$copyright = shift @ARGV;
|
||||
} elsif ($cmd eq "-verbatimcopying") {
|
||||
$verbatimcopying = 1;
|
||||
} elsif ($cmd eq "-seeinfo") {
|
||||
$seeinfo = shift @ARGV;
|
||||
} elsif ($cmd eq "-function") { # to only output specific functions
|
||||
$function_only = 1;
|
||||
$function = shift @ARGV;
|
||||
$function_table{$function} = 1;
|
||||
} elsif ($cmd eq "-v") {
|
||||
$verbose = 1;
|
||||
} elsif (($cmd eq "-h") || ($cmd eq "--help")) {
|
||||
usage();
|
||||
}
|
||||
}
|
||||
|
||||
##
|
||||
# dumps section contents to arrays/hashes intended for that purpose.
|
||||
#
|
||||
sub dump_section {
|
||||
my $name = shift @_;
|
||||
my $contents = join "\n", @_;
|
||||
|
||||
if ($name =~ m/$type_constant/) {
|
||||
$name = $1;
|
||||
# print STDERR "constant section '$1' = '$contents'\n";
|
||||
$constants{$name} = $contents;
|
||||
} elsif ($name =~ m/$type_param/) {
|
||||
# print STDERR "parameter def '$1' = '$contents'\n";
|
||||
$name = $1;
|
||||
$parameters{$name} = $contents;
|
||||
} else {
|
||||
# print STDERR "other section '$name' = '$contents'\n";
|
||||
$sections{$name} = $contents;
|
||||
push @sectionlist, $name;
|
||||
}
|
||||
}
|
||||
|
||||
##
|
||||
# output function
|
||||
#
|
||||
# parameters, a hash.
|
||||
# function => "function name"
|
||||
# parameterlist => @list of parameters
|
||||
# parameters => %parameter descriptions
|
||||
# sectionlist => @list of sections
|
||||
# sections => %descriont descriptions
|
||||
#
|
||||
|
||||
sub repstr {
|
||||
$pattern = shift;
|
||||
$repl = shift;
|
||||
$match1 = shift;
|
||||
$match2 = shift;
|
||||
$match3 = shift;
|
||||
$match4 = shift;
|
||||
|
||||
$output = $repl;
|
||||
$output =~ s,\$1,$match1,g;
|
||||
$output =~ s,\$2,$match2,g;
|
||||
$output =~ s,\$3,$match3,g;
|
||||
$output =~ s,\$4,$match4,g;
|
||||
|
||||
eval "\$return = qq/$output/";
|
||||
|
||||
# print "pattern $pattern matched 1=$match1 2=$match2 3=$match3 4=$match4 replace $repl yielded $output interpolated $return\n";
|
||||
|
||||
$return;
|
||||
}
|
||||
|
||||
sub just_highlight {
|
||||
my $contents = join "\n", @_;
|
||||
my $line;
|
||||
my $ret = "";
|
||||
|
||||
foreach $pattern (keys %highlights) {
|
||||
# print "scanning pattern $pattern ($highlights{$pattern})\n";
|
||||
$contents =~ s:$pattern:repstr($pattern, $highlights{$pattern}, $1, $2, $3, $4):gse;
|
||||
}
|
||||
foreach $line (split "\n", $contents) {
|
||||
if ($line eq ""){
|
||||
$ret = $ret . $lineprefix . $blankline;
|
||||
} else {
|
||||
$ret = $ret . $lineprefix . $line;
|
||||
}
|
||||
$ret = $ret . "\n";
|
||||
}
|
||||
|
||||
return $ret;
|
||||
}
|
||||
|
||||
sub output_highlight {
|
||||
print (just_highlight (@_));
|
||||
}
|
||||
|
||||
# output in texinfo
|
||||
sub output_texinfo {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
|
||||
print "\@subheading ".$args{'function'}."\n";
|
||||
print "\@anchor{".$args{'function'}."}\n";
|
||||
print "\@deftypefun {" . $args{'functiontype'} . "} ";
|
||||
print "{".$args{'function'}."} ";
|
||||
print "(";
|
||||
$count = 0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print $args{'parametertypes'}{$parameter}." \@var{".$parameter."}";
|
||||
if ($count != $#{$args{'parameterlist'}}) {
|
||||
$count++;
|
||||
print ", ";
|
||||
}
|
||||
}
|
||||
print ")\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
if ($args{'parameters'}{$parameter}) {
|
||||
print "\@var{".$parameter."}: ";
|
||||
output_highlight($args{'parameters'}{$parameter});
|
||||
print "\n";
|
||||
}
|
||||
}
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print "\n\@strong{$section:} " if $section ne $section_default;
|
||||
$args{'sections'}{$section} =~ s:([{}]):\@\1:gs;
|
||||
output_highlight($args{'sections'}{$section});
|
||||
}
|
||||
print "\@end deftypefun\n\n";
|
||||
}
|
||||
|
||||
# output in html
|
||||
sub output_html {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
print "\n\n<a name=\"". $args{'function'} . "\"> </a><h2>Function</h2>\n";
|
||||
|
||||
print "<i>".$args{'functiontype'}."</i>\n";
|
||||
print "<b>".$args{'function'}."</b>\n";
|
||||
print "(";
|
||||
$count = 0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print "<i>".$args{'parametertypes'}{$parameter}."</i> <b>".$parameter."</b>\n";
|
||||
if ($count != $#{$args{'parameterlist'}}) {
|
||||
$count++;
|
||||
print ", ";
|
||||
}
|
||||
}
|
||||
print ")\n";
|
||||
|
||||
print "<h3>Arguments</h3>\n";
|
||||
print "<dl>\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print "<dt><i>".$args{'parametertypes'}{$parameter}."</i> <b>".$parameter."</b>\n";
|
||||
print "<dd>";
|
||||
output_highlight($args{'parameters'}{$parameter});
|
||||
}
|
||||
print "</dl>\n";
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print "<h3>$section</h3>\n";
|
||||
print "<ul>\n";
|
||||
output_highlight($args{'sections'}{$section});
|
||||
print "</ul>\n";
|
||||
}
|
||||
print "<hr>\n";
|
||||
}
|
||||
|
||||
# output in tex
|
||||
sub output_tex {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
my $func = $args{'function'};
|
||||
my $param;
|
||||
my $param2;
|
||||
my $sec;
|
||||
my $check;
|
||||
my $type;
|
||||
|
||||
$func =~ s/_/\\_/g;
|
||||
|
||||
print "\n\n\\subsection{". $func . "}\n\\label{" . $args{'function'} . "}\n";
|
||||
|
||||
$type = $args{'functiontype'};
|
||||
$type =~ s/_/\\_/g;
|
||||
|
||||
print "{\\it ".$type."}\n";
|
||||
print "{\\bf ".$func."}\n";
|
||||
print "(";
|
||||
$count = 0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
$param = $args{'parametertypes'}{$parameter};
|
||||
$param2 = $parameter;
|
||||
$param =~ s/_/\\_/g;
|
||||
$param2 =~ s/_/\\_/g;
|
||||
|
||||
print "{\\it ".$param."} {\\bf ".$param2."}";
|
||||
if ($count != $#{$args{'parameterlist'}}) {
|
||||
$count++;
|
||||
print ", ";
|
||||
}
|
||||
}
|
||||
print ")\n";
|
||||
|
||||
print "\n{\\large{Arguments}}\n";
|
||||
|
||||
print "\\begin{itemize}\n";
|
||||
$check=0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
$param1 = $args{'parametertypes'}{$parameter};
|
||||
$param1 =~ s/_/\\_/g;
|
||||
$param2 = $parameter;
|
||||
$param2 =~ s/_/\\_/g;
|
||||
|
||||
$check = 1;
|
||||
print "\\item {\\it ".$param1."} {\\bf ".$param2."}: \n";
|
||||
# print "\n";
|
||||
|
||||
$param3 = $args{'parameters'}{$parameter};
|
||||
$param3 =~ s/#([a-zA-Z\_]+)/{\\it \1}/g;
|
||||
|
||||
$out = just_highlight($param3);
|
||||
$out =~ s/_/\\_/g;
|
||||
print $out;
|
||||
}
|
||||
if ($check==0) {
|
||||
print "\\item void\n";
|
||||
}
|
||||
print "\\end{itemize}\n";
|
||||
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
$sec = $section;
|
||||
$sec =~ s/_/\\_/g;
|
||||
$sec =~ s/#([a-zA-Z\_]+)/{\\it \1}/g;
|
||||
|
||||
print "\n{\\large{$sec}}\\\\\n";
|
||||
print "\\begin{rmfamily}\n";
|
||||
|
||||
$sec = $args{'sections'}{$section};
|
||||
$sec =~ s/\\:/:/g;
|
||||
$sec =~ s/#([a-zA-Z\_]+)/{\\it \1}/g;
|
||||
$sec =~ s/->/\$\\rightarrow\$/g;
|
||||
$sec =~ s/([0-9]+)\^([0-9]+)/\$\{\1\}\^\{\2\}\$/g;
|
||||
|
||||
$out = just_highlight($sec);
|
||||
$out =~ s/_/\\_/g;
|
||||
|
||||
print $out;
|
||||
print "\\end{rmfamily}\n";
|
||||
}
|
||||
print "\n";
|
||||
}
|
||||
|
||||
|
||||
# output in sgml DocBook
|
||||
sub output_sgml {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
my $id;
|
||||
|
||||
$id = $args{'module'}."-".$args{'function'};
|
||||
$id =~ s/[^A-Za-z0-9]/-/g;
|
||||
|
||||
print "<refentry>\n";
|
||||
print "<refmeta>\n";
|
||||
print "<refentrytitle><phrase id=\"$id\">".$args{'function'}."</phrase></refentrytitle>\n";
|
||||
print "</refmeta>\n";
|
||||
print "<refnamediv>\n";
|
||||
print " <refname>".$args{'function'}."</refname>\n";
|
||||
print " <refpurpose>\n";
|
||||
print " ".$args{'purpose'}."\n";
|
||||
print " </refpurpose>\n";
|
||||
print "</refnamediv>\n";
|
||||
|
||||
print "<refsynopsisdiv>\n";
|
||||
print " <title>Synopsis</title>\n";
|
||||
print " <funcsynopsis>\n";
|
||||
print " <funcdef>".$args{'functiontype'}." ";
|
||||
print "<function>".$args{'function'}." ";
|
||||
print "</function></funcdef>\n";
|
||||
|
||||
# print "<refsect1>\n";
|
||||
# print " <title>Synopsis</title>\n";
|
||||
# print " <funcsynopsis>\n";
|
||||
# print " <funcdef>".$args{'functiontype'}." ";
|
||||
# print "<function>".$args{'function'}." ";
|
||||
# print "</function></funcdef>\n";
|
||||
|
||||
$count = 0;
|
||||
if ($#{$args{'parameterlist'}} >= 0) {
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print " <paramdef>".$args{'parametertypes'}{$parameter};
|
||||
print " <parameter>$parameter</parameter></paramdef>\n";
|
||||
}
|
||||
} else {
|
||||
print " <void>\n";
|
||||
}
|
||||
print " </funcsynopsis>\n";
|
||||
print "</refsynopsisdiv>\n";
|
||||
# print "</refsect1>\n";
|
||||
|
||||
# print parameters
|
||||
print "<refsect1>\n <title>Arguments</title>\n";
|
||||
# print "<para>\nArguments\n";
|
||||
if ($#{$args{'parameterlist'}} >= 0) {
|
||||
print " <variablelist>\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
|
||||
print " <listitem>\n <para>\n";
|
||||
$lineprefix=" ";
|
||||
output_highlight($args{'parameters'}{$parameter});
|
||||
print " </para>\n </listitem>\n </varlistentry>\n";
|
||||
}
|
||||
print " </variablelist>\n";
|
||||
} else {
|
||||
print " <para>\n None\n </para>\n";
|
||||
}
|
||||
print "</refsect1>\n";
|
||||
|
||||
# print out each section
|
||||
$lineprefix=" ";
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print "<refsect1>\n <title>$section</title>\n <para>\n";
|
||||
# print "<para>\n$section\n";
|
||||
if ($section =~ m/EXAMPLE/i) {
|
||||
print "<example><para>\n";
|
||||
}
|
||||
output_highlight($args{'sections'}{$section});
|
||||
# print "</para>";
|
||||
if ($section =~ m/EXAMPLE/i) {
|
||||
print "</para></example>\n";
|
||||
}
|
||||
print " </para>\n</refsect1>\n";
|
||||
}
|
||||
|
||||
print "\n\n";
|
||||
}
|
||||
|
||||
##
|
||||
# output in man
|
||||
sub output_man {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
|
||||
print ".\\\" DO NOT MODIFY THIS FILE! It was generated by gdoc.\n";
|
||||
print ".TH \"$args{'function'}\" 3 \"$args{'sourceversion'}\" \"". $args{'module'} . "\" \"". $args{'module'} . "\"\n";
|
||||
|
||||
print ".SH NAME\n";
|
||||
|
||||
print $args{'function'};
|
||||
if ($args{'purpose'}) {
|
||||
print " \\- " . $args{'purpose'} . "\n";
|
||||
} else {
|
||||
print " \\- API function\n";
|
||||
}
|
||||
|
||||
print ".SH SYNOPSIS\n";
|
||||
print ".B #include <". $args{'include'} . ">\n"
|
||||
if $args{'include'};
|
||||
print ".B #include <". lc((split /_/, $args{'function'})[0]) . ".h>\n"
|
||||
if $args{'includefuncprefix'};
|
||||
print ".sp\n";
|
||||
print ".BI \"".$args{'functiontype'}." ".$args{'function'}."(";
|
||||
$count = 0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print $args{'parametertypes'}{$parameter}." \" ".$parameter." \"";
|
||||
if ($count != $#{$args{'parameterlist'}}) {
|
||||
$count++;
|
||||
print ", ";
|
||||
}
|
||||
}
|
||||
print ");\"\n";
|
||||
|
||||
print ".SH ARGUMENTS\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print ".IP \"".$args{'parametertypes'}{$parameter}." ".$parameter."\" 12\n";
|
||||
$param = $args{'parameters'}{$parameter};
|
||||
$param =~ s/-/\\-/g;
|
||||
output_highlight($param);
|
||||
}
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print ".SH \"" . uc($section) . "\"\n";
|
||||
$sec = $args{'sections'}{$section};
|
||||
$sec =~ s/-/\\-/g;
|
||||
output_highlight($sec);
|
||||
}
|
||||
|
||||
if ($args{'bugsto'}) {
|
||||
print ".SH \"REPORTING BUGS\"\n";
|
||||
print "Report bugs to <". $args{'bugsto'} . ">.\n";
|
||||
if ($args{'pkgname'}) {
|
||||
print $args{'pkgname'} . " home page: " .
|
||||
"http://www.gnu.org/software/" . $args{'module'} . "/\n";
|
||||
}
|
||||
print "General help using GNU software: http://www.gnu.org/gethelp/\n";
|
||||
}
|
||||
|
||||
if ($args{'copyright'}) {
|
||||
print ".SH COPYRIGHT\n";
|
||||
print "Copyright \\(co ". $args{'copyright'} . ".\n";
|
||||
if ($args{'verbatimcopying'}) {
|
||||
print ".br\n";
|
||||
print "Copying and distribution of this file, with or without modification,\n";
|
||||
print "are permitted in any medium without royalty provided the copyright\n";
|
||||
print "notice and this notice are preserved.\n";
|
||||
}
|
||||
}
|
||||
|
||||
if ($args{'seeinfo'}) {
|
||||
print ".SH \"SEE ALSO\"\n";
|
||||
print "The full documentation for\n";
|
||||
print ".B " . $args{'module'} . "\n";
|
||||
print "is maintained as a Texinfo manual. If the\n";
|
||||
print ".B info\n";
|
||||
print "and\n";
|
||||
print ".B " . $args{'module'} . "\n";
|
||||
print "programs are properly installed at your site, the command\n";
|
||||
print ".IP\n";
|
||||
print ".B info " . $args{'seeinfo'} . "\n";
|
||||
print ".PP\n";
|
||||
print "should give you access to the complete manual.\n";
|
||||
}
|
||||
}
|
||||
|
||||
sub output_listfunc {
|
||||
my %args = %{$_[0]};
|
||||
print $args{'function'} . "\n";
|
||||
}
|
||||
|
||||
##
|
||||
# output in text
|
||||
sub output_text {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
|
||||
print "Function = ".$args{'function'}."\n";
|
||||
print " return type: ".$args{'functiontype'}."\n\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print " ".$args{'parametertypes'}{$parameter}." ".$parameter."\n";
|
||||
print " -> ".$args{'parameters'}{$parameter}."\n";
|
||||
}
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print " $section:\n";
|
||||
print " -> ";
|
||||
output_highlight($args{'sections'}{$section});
|
||||
}
|
||||
}
|
||||
|
||||
##
|
||||
# generic output function - calls the right one based
|
||||
# on current output mode.
|
||||
sub output_function {
|
||||
# output_html(@_);
|
||||
eval "output_".$output_mode."(\@_);";
|
||||
}
|
||||
|
||||
|
||||
##
|
||||
# takes a function prototype and spits out all the details
|
||||
# stored in the global arrays/hsahes.
|
||||
sub dump_function {
|
||||
my $prototype = shift @_;
|
||||
|
||||
if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/ ||
|
||||
$prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/ ||
|
||||
$prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/ ||
|
||||
$prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/ ||
|
||||
$prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/) {
|
||||
$return_type = $1;
|
||||
$function_name = $2;
|
||||
$args = $3;
|
||||
|
||||
# print STDERR "ARGS = '$args'\n";
|
||||
|
||||
foreach $arg (split ',', $args) {
|
||||
# strip leading/trailing spaces
|
||||
$arg =~ s/^\s*//;
|
||||
$arg =~ s/\s*$//;
|
||||
# print STDERR "SCAN ARG: '$arg'\n";
|
||||
@args = split('\s', $arg);
|
||||
|
||||
# print STDERR " -> @args\n";
|
||||
$param = pop @args;
|
||||
# print STDERR " -> @args\n";
|
||||
if ($param =~ m/^(\*+)(.*)/) {
|
||||
$param = $2;
|
||||
push @args, $1;
|
||||
}
|
||||
if ($param =~ m/^(.*)(\[\])$/) {
|
||||
$param = $1;
|
||||
push @args, $2;
|
||||
}
|
||||
# print STDERR " :> @args\n";
|
||||
$type = join " ", @args;
|
||||
|
||||
if ($parameters{$param} eq "" && $param != "void") {
|
||||
$parameters{$param} = "-- undescribed --";
|
||||
print STDERR "warning: $lineno: Function parameter '$param' not described in '$function_name'\n";
|
||||
}
|
||||
|
||||
push @parameterlist, $param;
|
||||
$parametertypes{$param} = $type;
|
||||
|
||||
# print STDERR "param = '$param', type = '$type'\n";
|
||||
}
|
||||
} else {
|
||||
print STDERR "warning: $lineno: Cannot understand prototype: '$prototype'\n";
|
||||
return;
|
||||
}
|
||||
|
||||
if ($function_only==0 || defined($function_table{$function_name})) {
|
||||
output_function({'function' => $function_name,
|
||||
'module' => $modulename,
|
||||
'sourceversion' => $sourceversion,
|
||||
'include' => $include,
|
||||
'includefuncprefix' => $includefuncprefix,
|
||||
'bugsto' => $bugsto,
|
||||
'pkgname' => $pkgname,
|
||||
'copyright' => $copyright,
|
||||
'verbatimcopying' => $verbatimcopying,
|
||||
'seeinfo' => $seeinfo,
|
||||
'functiontype' => $return_type,
|
||||
'parameterlist' => \@parameterlist,
|
||||
'parameters' => \%parameters,
|
||||
'parametertypes' => \%parametertypes,
|
||||
'sectionlist' => \@sectionlist,
|
||||
'sections' => \%sections,
|
||||
'purpose' => $function_purpose
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
######################################################################
|
||||
# main
|
||||
# states
|
||||
# 0 - normal code
|
||||
# 1 - looking for function name
|
||||
# 2 - scanning field start.
|
||||
# 3 - scanning prototype.
|
||||
$state = 0;
|
||||
$section = "";
|
||||
|
||||
$doc_special = "\@\%\$\#";
|
||||
|
||||
$doc_start = "^/\\*\\*\$";
|
||||
$doc_end = "\\*/";
|
||||
$doc_com = "\\s*\\*\\s*";
|
||||
$doc_func = $doc_com."(\\w+):?";
|
||||
$doc_sect = $doc_com."([".$doc_special."[:upper:]][\\w ]+):\\s*(.*)";
|
||||
$doc_content = $doc_com."(.*)";
|
||||
|
||||
%constants = ();
|
||||
%parameters = ();
|
||||
@parameterlist = ();
|
||||
%sections = ();
|
||||
@sectionlist = ();
|
||||
|
||||
$contents = "";
|
||||
$section_default = "Description"; # default section
|
||||
$section = $section_default;
|
||||
|
||||
$lineno = 0;
|
||||
foreach $file (@ARGV) {
|
||||
if (!open(IN,"<$file")) {
|
||||
print STDERR "Error: Cannot open file $file\n";
|
||||
next;
|
||||
}
|
||||
while (<IN>) {
|
||||
$lineno++;
|
||||
|
||||
if ($state == 0) {
|
||||
if (/$doc_start/o) {
|
||||
$state = 1; # next line is always the function name
|
||||
}
|
||||
} elsif ($state == 1) { # this line is the function name (always)
|
||||
if (/$doc_func/o) {
|
||||
$function = $1;
|
||||
$state = 2;
|
||||
if (/-\s*(.*)/) {
|
||||
$function_purpose = $1;
|
||||
} else {
|
||||
$function_purpose = "";
|
||||
}
|
||||
if ($verbose) {
|
||||
print STDERR "Info($lineno): Scanning doc for $function\n";
|
||||
}
|
||||
} else {
|
||||
print STDERR "warning: $lineno: Cannot understand $_ on line $lineno",
|
||||
" - I thought it was a doc line\n";
|
||||
$state = 0;
|
||||
}
|
||||
} elsif ($state == 2) { # look for head: lines, and include content
|
||||
if (/$doc_sect/o) {
|
||||
$newsection = $1;
|
||||
$newcontents = $2;
|
||||
|
||||
if ($contents ne "") {
|
||||
dump_section($section, $contents);
|
||||
$section = $section_default;
|
||||
}
|
||||
|
||||
$contents = $newcontents;
|
||||
if ($contents ne "") {
|
||||
$contents .= "\n";
|
||||
}
|
||||
$section = $newsection;
|
||||
} elsif (/$doc_end/) {
|
||||
|
||||
if ($contents ne "") {
|
||||
dump_section($section, $contents);
|
||||
$section = $section_default;
|
||||
$contents = "";
|
||||
}
|
||||
|
||||
# print STDERR "end of doc comment, looking for prototype\n";
|
||||
$prototype = "";
|
||||
$state = 3;
|
||||
} elsif (/$doc_content/) {
|
||||
# miguel-style comment kludge, look for blank lines after
|
||||
# @parameter line to signify start of description
|
||||
if ($1 eq "" && $section =~ m/^@/) {
|
||||
dump_section($section, $contents);
|
||||
$section = $section_default;
|
||||
$contents = "";
|
||||
} else {
|
||||
$contents .= $1."\n";
|
||||
}
|
||||
} else {
|
||||
# i dont know - bad line? ignore.
|
||||
print STDERR "warning: $lineno: Bad line: $_";
|
||||
}
|
||||
} elsif ($state == 3) { # scanning for function { (end of prototype)
|
||||
if (m#\s*/\*\s+MACDOC\s*#io) {
|
||||
# do nothing
|
||||
}
|
||||
elsif (/([^\{]*)/) {
|
||||
$prototype .= $1;
|
||||
}
|
||||
if (/\{/) {
|
||||
$prototype =~ s@/\*.*?\*/@@gos; # strip comments.
|
||||
$prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
|
||||
$prototype =~ s@^ +@@gos; # strip leading spaces
|
||||
dump_function($prototype);
|
||||
|
||||
$function = "";
|
||||
%constants = ();
|
||||
%parameters = ();
|
||||
%parametertypes = ();
|
||||
@parameterlist = ();
|
||||
%sections = ();
|
||||
@sectionlist = ();
|
||||
$prototype = "";
|
||||
|
||||
$state = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
912
doc/gdoc.orig
Executable file
912
doc/gdoc.orig
Executable file
@@ -0,0 +1,912 @@
|
||||
eval '(exit $?0)' && eval 'exec perl -S "$0" ${1+"$@"}'
|
||||
& eval 'exec perl -S "$0" $argv:q'
|
||||
if 0;
|
||||
# Generate documentation from source code.
|
||||
|
||||
## Copyright (c) 2002-2013 Simon Josefsson
|
||||
## added -texinfo, -listfunc, -pkg-name
|
||||
## man page revamp
|
||||
## various improvements
|
||||
## Copyright (c) 2001, 2002 Nikos Mavrogiannopoulos
|
||||
## added -tex
|
||||
## Copyright (c) 1998 Michael Zucchi
|
||||
|
||||
# This program is free software: you can redistribute it and/or modify
|
||||
# it under the terms of the GNU General Public License as published by
|
||||
# the Free Software Foundation, either version 3 of the License, or
|
||||
# (at your option) any later version.
|
||||
#
|
||||
# This program is distributed in the hope that it will be useful,
|
||||
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
||||
# GNU General Public License for more details.
|
||||
#
|
||||
# You should have received a copy of the GNU General Public License
|
||||
# along with this program. If not, see <http://www.gnu.org/licenses/>.
|
||||
|
||||
# This will read a C source code file and scan for embedded comments
|
||||
# in the style of gnome comments (+minor extensions - see below).
|
||||
|
||||
# usage:
|
||||
# gdoc [ -docbook | -html | -text | -man | -tex | -texinfo | -listfunc ]
|
||||
# [ -sourceversion verno ] [ -include file | -includefuncprefix ]
|
||||
# [ -bugsto address ] [ -pkg-name packagename ]
|
||||
# [ -seeinfo infonode ] [ -copyright notice ] [ -verbatimcopying ]
|
||||
# [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile
|
||||
#
|
||||
# Set output format using one of -docbook, -html, -text, -man, -tex,
|
||||
# -texinfo, or -listfunc. Default is man.
|
||||
#
|
||||
# -sourceversion
|
||||
# Version number for source code, e.g. '1.0.4'. Used in 'man' headers.
|
||||
# Defaults to using current date.
|
||||
#
|
||||
# -include FILE
|
||||
# For man pages, mention #include <FILE.h> in the synopsis.
|
||||
#
|
||||
# -includefuncprefix
|
||||
# For man pages, mention a #include <FILE.h> in the synopsis.
|
||||
# The FILE derived from the function prefix. For example, a
|
||||
# function gss_init_sec_context will generate an include
|
||||
# statement of #include <gss.h>.
|
||||
#
|
||||
# -bugsto address
|
||||
# For man pages, include a section about reporting bugs and mention
|
||||
# the given e-mail address, e.g 'bug-libidn@gnu.org'.
|
||||
#
|
||||
# -pkg-name packagename
|
||||
# For man pages when -bugsto is used, also include help URLs to the
|
||||
# the project's home page. For example, "GNU Libidn".
|
||||
#
|
||||
# -seeinfo infonode
|
||||
# For man pages, include a section that point to an info manual
|
||||
# for more information.
|
||||
#
|
||||
# -copyright notice
|
||||
# For man pages, include a copyright section with the given
|
||||
# notice after a preamble. Use, e.g., '2002, 2003 Simon Josefsson'.
|
||||
#
|
||||
# -verbatimcopying
|
||||
# For man pages, and when the -copyright parameter is used,
|
||||
# add a licensing statement that say verbatim copying is permitted.
|
||||
#
|
||||
# -function funcname
|
||||
# If set, then only generate documentation for the given function(s). All
|
||||
# other functions are ignored.
|
||||
#
|
||||
# c files - list of 'c' files to process
|
||||
#
|
||||
# All output goes to stdout, with errors to stderr.
|
||||
|
||||
#
|
||||
# format of comments.
|
||||
# In the following table, (...)? signifies optional structure.
|
||||
# (...)* signifies 0 or more structure elements
|
||||
# /**
|
||||
# * function_name(:)? (- short description)?
|
||||
# (* @parameterx: (description of parameter x)?)*
|
||||
# (* a blank line)?
|
||||
# * (Description:)? (Description of function)?
|
||||
# * (Section header: (section description)? )*
|
||||
# (*)?*/
|
||||
#
|
||||
# So .. the trivial example would be:
|
||||
#
|
||||
# /**
|
||||
# * my_function
|
||||
# **/
|
||||
#
|
||||
# If the Description: header tag is ommitted, then there must be a blank line
|
||||
# after the last parameter specification.
|
||||
# e.g.
|
||||
# /**
|
||||
# * my_function - does my stuff
|
||||
# * @my_arg: its mine damnit
|
||||
# *
|
||||
# * Does my stuff explained.
|
||||
# */
|
||||
#
|
||||
# or, could also use:
|
||||
# /**
|
||||
# * my_function - does my stuff
|
||||
# * @my_arg: its mine damnit
|
||||
# * Description: Does my stuff explained.
|
||||
# */
|
||||
# etc.
|
||||
#
|
||||
# All descriptions can be multiline, apart from the short function description.
|
||||
#
|
||||
# All descriptive text is further processed, scanning for the following special
|
||||
# patterns, which are highlighted appropriately.
|
||||
#
|
||||
# 'funcname()' - function
|
||||
# '$ENVVAR' - environmental variable OBSOLETE (?)
|
||||
# '#struct_name' - name of a structure
|
||||
# '@parameter' - name of a parameter
|
||||
# '%CONST' - name of a constant.
|
||||
|
||||
#
|
||||
# Extensions for LaTeX:
|
||||
#
|
||||
# 1. the symbol '->' will be replaced with a rightarrow
|
||||
# 2. x^y with ${x}^{y}$.
|
||||
# 3. xxx\: with xxx:
|
||||
|
||||
use POSIX qw(strftime);
|
||||
|
||||
# match expressions used to find embedded type information
|
||||
$type_constant = "\\\%(\\w+)";
|
||||
$type_func = "(\\w+\\(\\))";
|
||||
$type_param = "\\\@(\\w+)";
|
||||
$type_struct = "\\\#(\\w+)";
|
||||
$type_env = "(\\\$\\w+)";
|
||||
|
||||
|
||||
# Output conversion substitutions.
|
||||
# One for each output format
|
||||
|
||||
# these work fairly well
|
||||
%highlights_html = ( $type_constant, "<i>\$1</i>",
|
||||
$type_func, "<b>\$1</b>",
|
||||
$type_struct, "<i>\$1</i>",
|
||||
$type_param, "<tt><b>\$1</b></tt>" );
|
||||
$blankline_html = "<p>";
|
||||
|
||||
%highlights_texinfo = ( $type_constant, "\\\@code{\$1}",
|
||||
$type_func, "\\\@code{\$1}",
|
||||
$type_struct, "\\\@code{\$1}",
|
||||
$type_param, "\\\@code{\$1}" );
|
||||
$blankline_texinfo = "";
|
||||
|
||||
%highlights_tex = ( $type_constant, "{\\\\it \$1}",
|
||||
$type_func, "{\\\\bf \$1}",
|
||||
$type_struct, "{\\\\it \$1}",
|
||||
$type_param, "{\\\\bf \$1}" );
|
||||
$blankline_tex = "\\\\";
|
||||
|
||||
# sgml, docbook format
|
||||
%highlights_sgml = ( $type_constant, "<replaceable class=\"option\">\$1</replaceable>",
|
||||
$type_func, "<function>\$1</function>",
|
||||
$type_struct, "<structname>\$1</structname>",
|
||||
$type_env, "<envar>\$1</envar>",
|
||||
$type_param, "<parameter>\$1</parameter>" );
|
||||
$blankline_sgml = "</para><para>\n";
|
||||
|
||||
# these are pretty rough
|
||||
%highlights_man = ( $type_constant, "\\\\fB\$1\\\\fP",
|
||||
$type_func, "\\\\fB\$1\\\\fP",
|
||||
$type_struct, "\\\\fB\$1\\\\fP",
|
||||
$type_param, "\\\\fI\$1\\\\fP" );
|
||||
$blankline_man = "";
|
||||
|
||||
# text-mode
|
||||
%highlights_text = ( $type_constant, "\$1",
|
||||
$type_func, "\$1",
|
||||
$type_struct, "\$1",
|
||||
$type_param, "\$1" );
|
||||
$blankline_text = "";
|
||||
|
||||
|
||||
sub usage {
|
||||
print "Usage: $0 [ -v ] [ -docbook | -html | -text | -man | -tex | -texinfo -listfunc ]\n";
|
||||
print " [ -sourceversion verno ] [ -include file | -includefuncprefix ]\n";
|
||||
print " [ -bugsto address ] [ -seeinfo infonode ] [ -copyright notice]\n";
|
||||
print " [ -verbatimcopying ] [ -pkg-name packagename ]\n";
|
||||
print " [ -function funcname [ -function funcname ...] ]\n";
|
||||
print " c source file(s) > outputfile\n";
|
||||
exit 1;
|
||||
}
|
||||
|
||||
# read arguments
|
||||
if ($#ARGV==-1) {
|
||||
usage();
|
||||
}
|
||||
|
||||
$verbose = 0;
|
||||
$output_mode = "man";
|
||||
%highlights = %highlights_man;
|
||||
$blankline = $blankline_man;
|
||||
$modulename = "API Documentation";
|
||||
$sourceversion = strftime "%Y-%m-%d", localtime;
|
||||
$function_only = 0;
|
||||
while ($ARGV[0] =~ m/^-(.*)/) {
|
||||
$cmd = shift @ARGV;
|
||||
if ($cmd eq "-html") {
|
||||
$output_mode = "html";
|
||||
%highlights = %highlights_html;
|
||||
$blankline = $blankline_html;
|
||||
} elsif ($cmd eq "-man") {
|
||||
$output_mode = "man";
|
||||
%highlights = %highlights_man;
|
||||
$blankline = $blankline_man;
|
||||
} elsif ($cmd eq "-tex") {
|
||||
$output_mode = "tex";
|
||||
%highlights = %highlights_tex;
|
||||
$blankline = $blankline_tex;
|
||||
} elsif ($cmd eq "-texinfo") {
|
||||
$output_mode = "texinfo";
|
||||
%highlights = %highlights_texinfo;
|
||||
$blankline = $blankline_texinfo;
|
||||
} elsif ($cmd eq "-text") {
|
||||
$output_mode = "text";
|
||||
%highlights = %highlights_text;
|
||||
$blankline = $blankline_text;
|
||||
} elsif ($cmd eq "-docbook") {
|
||||
$output_mode = "sgml";
|
||||
%highlights = %highlights_sgml;
|
||||
$blankline = $blankline_sgml;
|
||||
} elsif ($cmd eq "-listfunc") {
|
||||
$output_mode = "listfunc";
|
||||
} elsif ($cmd eq "-module") { # not needed for sgml, inherits from calling document
|
||||
$modulename = shift @ARGV;
|
||||
} elsif ($cmd eq "-sourceversion") {
|
||||
$sourceversion = shift @ARGV;
|
||||
} elsif ($cmd eq "-include") {
|
||||
$include = shift @ARGV;
|
||||
} elsif ($cmd eq "-includefuncprefix") {
|
||||
$includefuncprefix = 1;
|
||||
} elsif ($cmd eq "-bugsto") {
|
||||
$bugsto = shift @ARGV;
|
||||
} elsif ($cmd eq "-pkg-name") {
|
||||
$pkgname = shift @ARGV;
|
||||
} elsif ($cmd eq "-copyright") {
|
||||
$copyright = shift @ARGV;
|
||||
} elsif ($cmd eq "-verbatimcopying") {
|
||||
$verbatimcopying = 1;
|
||||
} elsif ($cmd eq "-seeinfo") {
|
||||
$seeinfo = shift @ARGV;
|
||||
} elsif ($cmd eq "-function") { # to only output specific functions
|
||||
$function_only = 1;
|
||||
$function = shift @ARGV;
|
||||
$function_table{$function} = 1;
|
||||
} elsif ($cmd eq "-v") {
|
||||
$verbose = 1;
|
||||
} elsif (($cmd eq "-h") || ($cmd eq "--help")) {
|
||||
usage();
|
||||
}
|
||||
}
|
||||
|
||||
##
|
||||
# dumps section contents to arrays/hashes intended for that purpose.
|
||||
#
|
||||
sub dump_section {
|
||||
my $name = shift @_;
|
||||
my $contents = join "\n", @_;
|
||||
|
||||
if ($name =~ m/$type_constant/) {
|
||||
$name = $1;
|
||||
# print STDERR "constant section '$1' = '$contents'\n";
|
||||
$constants{$name} = $contents;
|
||||
} elsif ($name =~ m/$type_param/) {
|
||||
# print STDERR "parameter def '$1' = '$contents'\n";
|
||||
$name = $1;
|
||||
$parameters{$name} = $contents;
|
||||
} else {
|
||||
# print STDERR "other section '$name' = '$contents'\n";
|
||||
$sections{$name} = $contents;
|
||||
push @sectionlist, $name;
|
||||
}
|
||||
}
|
||||
|
||||
##
|
||||
# output function
|
||||
#
|
||||
# parameters, a hash.
|
||||
# function => "function name"
|
||||
# parameterlist => @list of parameters
|
||||
# parameters => %parameter descriptions
|
||||
# sectionlist => @list of sections
|
||||
# sections => %descriont descriptions
|
||||
#
|
||||
|
||||
sub repstr {
|
||||
$pattern = shift;
|
||||
$repl = shift;
|
||||
$match1 = shift;
|
||||
$match2 = shift;
|
||||
$match3 = shift;
|
||||
$match4 = shift;
|
||||
|
||||
$output = $repl;
|
||||
$output =~ s,\$1,$match1,g;
|
||||
$output =~ s,\$2,$match2,g;
|
||||
$output =~ s,\$3,$match3,g;
|
||||
$output =~ s,\$4,$match4,g;
|
||||
|
||||
eval "\$return = qq/$output/";
|
||||
|
||||
# print "pattern $pattern matched 1=$match1 2=$match2 3=$match3 4=$match4 replace $repl yielded $output interpolated $return\n";
|
||||
|
||||
$return;
|
||||
}
|
||||
|
||||
sub just_highlight {
|
||||
my $contents = join "\n", @_;
|
||||
my $line;
|
||||
my $ret = "";
|
||||
|
||||
foreach $pattern (keys %highlights) {
|
||||
# print "scanning pattern $pattern ($highlights{$pattern})\n";
|
||||
$contents =~ s:$pattern:repstr($pattern, $highlights{$pattern}, $1, $2, $3, $4):gse;
|
||||
}
|
||||
foreach $line (split "\n", $contents) {
|
||||
if ($line eq ""){
|
||||
$ret = $ret . $lineprefix . $blankline;
|
||||
} else {
|
||||
$ret = $ret . $lineprefix . $line;
|
||||
}
|
||||
$ret = $ret . "\n";
|
||||
}
|
||||
|
||||
return $ret;
|
||||
}
|
||||
|
||||
sub output_highlight {
|
||||
print (just_highlight (@_));
|
||||
}
|
||||
|
||||
# output in texinfo
|
||||
sub output_texinfo {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
|
||||
print "\@subheading ".$args{'function'}."\n";
|
||||
print "\@anchor{".$args{'function'}."}\n";
|
||||
print "\@deftypefun {" . $args{'functiontype'} . "} ";
|
||||
print "{".$args{'function'}."} ";
|
||||
print "(";
|
||||
$count = 0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print $args{'parametertypes'}{$parameter}." \@var{".$parameter."}";
|
||||
if ($count != $#{$args{'parameterlist'}}) {
|
||||
$count++;
|
||||
print ", ";
|
||||
}
|
||||
}
|
||||
print ")\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
if ($args{'parameters'}{$parameter}) {
|
||||
print "\@var{".$parameter."}: ";
|
||||
output_highlight($args{'parameters'}{$parameter});
|
||||
print "\n";
|
||||
}
|
||||
}
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print "\n\@strong{$section:} " if $section ne $section_default;
|
||||
$args{'sections'}{$section} =~ s:([{}]):\@\1:gs;
|
||||
output_highlight($args{'sections'}{$section});
|
||||
}
|
||||
print "\@end deftypefun\n\n";
|
||||
}
|
||||
|
||||
# output in html
|
||||
sub output_html {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
print "\n\n<a name=\"". $args{'function'} . "\"> </a><h2>Function</h2>\n";
|
||||
|
||||
print "<i>".$args{'functiontype'}."</i>\n";
|
||||
print "<b>".$args{'function'}."</b>\n";
|
||||
print "(";
|
||||
$count = 0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print "<i>".$args{'parametertypes'}{$parameter}."</i> <b>".$parameter."</b>\n";
|
||||
if ($count != $#{$args{'parameterlist'}}) {
|
||||
$count++;
|
||||
print ", ";
|
||||
}
|
||||
}
|
||||
print ")\n";
|
||||
|
||||
print "<h3>Arguments</h3>\n";
|
||||
print "<dl>\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print "<dt><i>".$args{'parametertypes'}{$parameter}."</i> <b>".$parameter."</b>\n";
|
||||
print "<dd>";
|
||||
output_highlight($args{'parameters'}{$parameter});
|
||||
}
|
||||
print "</dl>\n";
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print "<h3>$section</h3>\n";
|
||||
print "<ul>\n";
|
||||
output_highlight($args{'sections'}{$section});
|
||||
print "</ul>\n";
|
||||
}
|
||||
print "<hr>\n";
|
||||
}
|
||||
|
||||
# output in tex
|
||||
sub output_tex {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
my $func = $args{'function'};
|
||||
my $param;
|
||||
my $param2;
|
||||
my $sec;
|
||||
my $check;
|
||||
my $type;
|
||||
|
||||
$func =~ s/_/\\_/g;
|
||||
|
||||
print "\n\n\\subsection{". $func . "}\n\\label{" . $args{'function'} . "}\n";
|
||||
|
||||
$type = $args{'functiontype'};
|
||||
$type =~ s/_/\\_/g;
|
||||
|
||||
print "{\\it ".$type."}\n";
|
||||
print "{\\bf ".$func."}\n";
|
||||
print "(";
|
||||
$count = 0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
$param = $args{'parametertypes'}{$parameter};
|
||||
$param2 = $parameter;
|
||||
$param =~ s/_/\\_/g;
|
||||
$param2 =~ s/_/\\_/g;
|
||||
|
||||
print "{\\it ".$param."} {\\bf ".$param2."}";
|
||||
if ($count != $#{$args{'parameterlist'}}) {
|
||||
$count++;
|
||||
print ", ";
|
||||
}
|
||||
}
|
||||
print ")\n";
|
||||
|
||||
print "\n{\\large{Arguments}}\n";
|
||||
|
||||
print "\\begin{itemize}\n";
|
||||
$check=0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
$param1 = $args{'parametertypes'}{$parameter};
|
||||
$param1 =~ s/_/\\_/g;
|
||||
$param2 = $parameter;
|
||||
$param2 =~ s/_/\\_/g;
|
||||
|
||||
$check = 1;
|
||||
print "\\item {\\it ".$param1."} {\\bf ".$param2."}: \n";
|
||||
# print "\n";
|
||||
|
||||
$param3 = $args{'parameters'}{$parameter};
|
||||
$param3 =~ s/#([a-zA-Z\_]+)/{\\it \1}/g;
|
||||
|
||||
$out = just_highlight($param3);
|
||||
$out =~ s/_/\\_/g;
|
||||
print $out;
|
||||
}
|
||||
if ($check==0) {
|
||||
print "\\item void\n";
|
||||
}
|
||||
print "\\end{itemize}\n";
|
||||
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
$sec = $section;
|
||||
$sec =~ s/_/\\_/g;
|
||||
$sec =~ s/#([a-zA-Z\_]+)/{\\it \1}/g;
|
||||
|
||||
print "\n{\\large{$sec}}\\\\\n";
|
||||
print "\\begin{rmfamily}\n";
|
||||
|
||||
$sec = $args{'sections'}{$section};
|
||||
$sec =~ s/\\:/:/g;
|
||||
$sec =~ s/#([a-zA-Z\_]+)/{\\it \1}/g;
|
||||
$sec =~ s/->/\$\\rightarrow\$/g;
|
||||
$sec =~ s/([0-9]+)\^([0-9]+)/\$\{\1\}\^\{\2\}\$/g;
|
||||
|
||||
$out = just_highlight($sec);
|
||||
$out =~ s/_/\\_/g;
|
||||
|
||||
print $out;
|
||||
print "\\end{rmfamily}\n";
|
||||
}
|
||||
print "\n";
|
||||
}
|
||||
|
||||
|
||||
# output in sgml DocBook
|
||||
sub output_sgml {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
my $id;
|
||||
|
||||
$id = $args{'module'}."-".$args{'function'};
|
||||
$id =~ s/[^A-Za-z0-9]/-/g;
|
||||
|
||||
print "<refentry>\n";
|
||||
print "<refmeta>\n";
|
||||
print "<refentrytitle><phrase id=\"$id\">".$args{'function'}."</phrase></refentrytitle>\n";
|
||||
print "</refmeta>\n";
|
||||
print "<refnamediv>\n";
|
||||
print " <refname>".$args{'function'}."</refname>\n";
|
||||
print " <refpurpose>\n";
|
||||
print " ".$args{'purpose'}."\n";
|
||||
print " </refpurpose>\n";
|
||||
print "</refnamediv>\n";
|
||||
|
||||
print "<refsynopsisdiv>\n";
|
||||
print " <title>Synopsis</title>\n";
|
||||
print " <funcsynopsis>\n";
|
||||
print " <funcdef>".$args{'functiontype'}." ";
|
||||
print "<function>".$args{'function'}." ";
|
||||
print "</function></funcdef>\n";
|
||||
|
||||
# print "<refsect1>\n";
|
||||
# print " <title>Synopsis</title>\n";
|
||||
# print " <funcsynopsis>\n";
|
||||
# print " <funcdef>".$args{'functiontype'}." ";
|
||||
# print "<function>".$args{'function'}." ";
|
||||
# print "</function></funcdef>\n";
|
||||
|
||||
$count = 0;
|
||||
if ($#{$args{'parameterlist'}} >= 0) {
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print " <paramdef>".$args{'parametertypes'}{$parameter};
|
||||
print " <parameter>$parameter</parameter></paramdef>\n";
|
||||
}
|
||||
} else {
|
||||
print " <void>\n";
|
||||
}
|
||||
print " </funcsynopsis>\n";
|
||||
print "</refsynopsisdiv>\n";
|
||||
# print "</refsect1>\n";
|
||||
|
||||
# print parameters
|
||||
print "<refsect1>\n <title>Arguments</title>\n";
|
||||
# print "<para>\nArguments\n";
|
||||
if ($#{$args{'parameterlist'}} >= 0) {
|
||||
print " <variablelist>\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print " <varlistentry>\n <term><parameter>$parameter</parameter></term>\n";
|
||||
print " <listitem>\n <para>\n";
|
||||
$lineprefix=" ";
|
||||
output_highlight($args{'parameters'}{$parameter});
|
||||
print " </para>\n </listitem>\n </varlistentry>\n";
|
||||
}
|
||||
print " </variablelist>\n";
|
||||
} else {
|
||||
print " <para>\n None\n </para>\n";
|
||||
}
|
||||
print "</refsect1>\n";
|
||||
|
||||
# print out each section
|
||||
$lineprefix=" ";
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print "<refsect1>\n <title>$section</title>\n <para>\n";
|
||||
# print "<para>\n$section\n";
|
||||
if ($section =~ m/EXAMPLE/i) {
|
||||
print "<example><para>\n";
|
||||
}
|
||||
output_highlight($args{'sections'}{$section});
|
||||
# print "</para>";
|
||||
if ($section =~ m/EXAMPLE/i) {
|
||||
print "</para></example>\n";
|
||||
}
|
||||
print " </para>\n</refsect1>\n";
|
||||
}
|
||||
|
||||
print "\n\n";
|
||||
}
|
||||
|
||||
##
|
||||
# output in man
|
||||
sub output_man {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
my $count;
|
||||
|
||||
print ".\\\" DO NOT MODIFY THIS FILE! It was generated by gdoc.\n";
|
||||
print ".TH \"$args{'function'}\" 3 \"$args{'sourceversion'}\" \"". $args{'module'} . "\" \"". $args{'module'} . "\"\n";
|
||||
|
||||
print ".SH NAME\n";
|
||||
|
||||
print $args{'function'};
|
||||
if ($args{'purpose'}) {
|
||||
print " \\- " . $args{'purpose'} . "\n";
|
||||
} else {
|
||||
print " \\- API function\n";
|
||||
}
|
||||
|
||||
print ".SH SYNOPSIS\n";
|
||||
print ".B #include <". $args{'include'} . ">\n"
|
||||
if $args{'include'};
|
||||
print ".B #include <". lc((split /_/, $args{'function'})[0]) . ".h>\n"
|
||||
if $args{'includefuncprefix'};
|
||||
print ".sp\n";
|
||||
print ".BI \"".$args{'functiontype'}." ".$args{'function'}."(";
|
||||
$count = 0;
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print $args{'parametertypes'}{$parameter}." \" ".$parameter." \"";
|
||||
if ($count != $#{$args{'parameterlist'}}) {
|
||||
$count++;
|
||||
print ", ";
|
||||
}
|
||||
}
|
||||
print ");\"\n";
|
||||
|
||||
print ".SH ARGUMENTS\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print ".IP \"".$args{'parametertypes'}{$parameter}." ".$parameter."\" 12\n";
|
||||
$param = $args{'parameters'}{$parameter};
|
||||
$param =~ s/-/\\-/g;
|
||||
output_highlight($param);
|
||||
}
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print ".SH \"" . uc($section) . "\"\n";
|
||||
$sec = $args{'sections'}{$section};
|
||||
$sec =~ s/-/\\-/g;
|
||||
output_highlight($sec);
|
||||
}
|
||||
|
||||
if ($args{'bugsto'}) {
|
||||
print ".SH \"REPORTING BUGS\"\n";
|
||||
print "Report bugs to <". $args{'bugsto'} . ">.\n";
|
||||
if ($args{'pkgname'}) {
|
||||
print $args{'pkgname'} . " home page: " .
|
||||
"http://www.gnu.org/software/" . $args{'module'} . "/\n";
|
||||
}
|
||||
print "General help using GNU software: http://www.gnu.org/gethelp/\n";
|
||||
}
|
||||
|
||||
if ($args{'copyright'}) {
|
||||
print ".SH COPYRIGHT\n";
|
||||
print "Copyright \\(co ". $args{'copyright'} . ".\n";
|
||||
if ($args{'verbatimcopying'}) {
|
||||
print ".br\n";
|
||||
print "Copying and distribution of this file, with or without modification,\n";
|
||||
print "are permitted in any medium without royalty provided the copyright\n";
|
||||
print "notice and this notice are preserved.\n";
|
||||
}
|
||||
}
|
||||
|
||||
if ($args{'seeinfo'}) {
|
||||
print ".SH \"SEE ALSO\"\n";
|
||||
print "The full documentation for\n";
|
||||
print ".B " . $args{'module'} . "\n";
|
||||
print "is maintained as a Texinfo manual. If the\n";
|
||||
print ".B info\n";
|
||||
print "and\n";
|
||||
print ".B " . $args{'module'} . "\n";
|
||||
print "programs are properly installed at your site, the command\n";
|
||||
print ".IP\n";
|
||||
print ".B info " . $args{'seeinfo'} . "\n";
|
||||
print ".PP\n";
|
||||
print "should give you access to the complete manual.\n";
|
||||
}
|
||||
}
|
||||
|
||||
sub output_listfunc {
|
||||
my %args = %{$_[0]};
|
||||
print $args{'function'} . "\n";
|
||||
}
|
||||
|
||||
##
|
||||
# output in text
|
||||
sub output_text {
|
||||
my %args = %{$_[0]};
|
||||
my ($parameter, $section);
|
||||
|
||||
print "Function = ".$args{'function'}."\n";
|
||||
print " return type: ".$args{'functiontype'}."\n\n";
|
||||
foreach $parameter (@{$args{'parameterlist'}}) {
|
||||
print " ".$args{'parametertypes'}{$parameter}." ".$parameter."\n";
|
||||
print " -> ".$args{'parameters'}{$parameter}."\n";
|
||||
}
|
||||
foreach $section (@{$args{'sectionlist'}}) {
|
||||
print " $section:\n";
|
||||
print " -> ";
|
||||
output_highlight($args{'sections'}{$section});
|
||||
}
|
||||
}
|
||||
|
||||
##
|
||||
# generic output function - calls the right one based
|
||||
# on current output mode.
|
||||
sub output_function {
|
||||
# output_html(@_);
|
||||
eval "output_".$output_mode."(\@_);";
|
||||
}
|
||||
|
||||
|
||||
##
|
||||
# takes a function prototype and spits out all the details
|
||||
# stored in the global arrays/hsahes.
|
||||
sub dump_function {
|
||||
my $prototype = shift @_;
|
||||
|
||||
if ($prototype =~ m/^()([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/ ||
|
||||
$prototype =~ m/^(\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/ ||
|
||||
$prototype =~ m/^(\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/ ||
|
||||
$prototype =~ m/^(\w+\s+\w+)\s+([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/ ||
|
||||
$prototype =~ m/^(\w+\s+\w+\s*\*)\s*([a-zA-Z0-9_~:]+)\s*\(([^\)]*)\)/) {
|
||||
$return_type = $1;
|
||||
$function_name = $2;
|
||||
$args = $3;
|
||||
|
||||
# print STDERR "ARGS = '$args'\n";
|
||||
|
||||
foreach $arg (split ',', $args) {
|
||||
# strip leading/trailing spaces
|
||||
$arg =~ s/^\s*//;
|
||||
$arg =~ s/\s*$//;
|
||||
# print STDERR "SCAN ARG: '$arg'\n";
|
||||
@args = split('\s', $arg);
|
||||
|
||||
# print STDERR " -> @args\n";
|
||||
$param = pop @args;
|
||||
# print STDERR " -> @args\n";
|
||||
if ($param =~ m/^(\*+)(.*)/) {
|
||||
$param = $2;
|
||||
push @args, $1;
|
||||
}
|
||||
if ($param =~ m/^(.*)(\[\])$/) {
|
||||
$param = $1;
|
||||
push @args, $2;
|
||||
}
|
||||
# print STDERR " :> @args\n";
|
||||
$type = join " ", @args;
|
||||
|
||||
if ($parameters{$param} eq "" && $param != "void") {
|
||||
$parameters{$param} = "-- undescribed --";
|
||||
print STDERR "warning: $lineno: Function parameter '$param' not described in '$function_name'\n";
|
||||
}
|
||||
|
||||
push @parameterlist, $param;
|
||||
$parametertypes{$param} = $type;
|
||||
|
||||
# print STDERR "param = '$param', type = '$type'\n";
|
||||
}
|
||||
} else {
|
||||
print STDERR "warning: $lineno: Cannot understand prototype: '$prototype'\n";
|
||||
return;
|
||||
}
|
||||
|
||||
if ($function_only==0 || defined($function_table{$function_name})) {
|
||||
output_function({'function' => $function_name,
|
||||
'module' => $modulename,
|
||||
'sourceversion' => $sourceversion,
|
||||
'include' => $include,
|
||||
'includefuncprefix' => $includefuncprefix,
|
||||
'bugsto' => $bugsto,
|
||||
'pkgname' => $pkgname,
|
||||
'copyright' => $copyright,
|
||||
'verbatimcopying' => $verbatimcopying,
|
||||
'seeinfo' => $seeinfo,
|
||||
'functiontype' => $return_type,
|
||||
'parameterlist' => \@parameterlist,
|
||||
'parameters' => \%parameters,
|
||||
'parametertypes' => \%parametertypes,
|
||||
'sectionlist' => \@sectionlist,
|
||||
'sections' => \%sections,
|
||||
'purpose' => $function_purpose
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
######################################################################
|
||||
# main
|
||||
# states
|
||||
# 0 - normal code
|
||||
# 1 - looking for function name
|
||||
# 2 - scanning field start.
|
||||
# 3 - scanning prototype.
|
||||
$state = 0;
|
||||
$section = "";
|
||||
|
||||
$doc_special = "\@\%\$\#";
|
||||
|
||||
$doc_start = "^/\\*\\*\$";
|
||||
$doc_end = "\\*/";
|
||||
$doc_com = "\\s*\\*\\s*";
|
||||
$doc_func = $doc_com."(\\w+):?";
|
||||
$doc_sect = $doc_com."([".$doc_special."[:upper:]][\\w ]+):\\s*(.*)";
|
||||
$doc_content = $doc_com."(.*)";
|
||||
|
||||
%constants = ();
|
||||
%parameters = ();
|
||||
@parameterlist = ();
|
||||
%sections = ();
|
||||
@sectionlist = ();
|
||||
|
||||
$contents = "";
|
||||
$section_default = "Description"; # default section
|
||||
$section = $section_default;
|
||||
|
||||
$lineno = 0;
|
||||
foreach $file (@ARGV) {
|
||||
if (!open(IN,"<$file")) {
|
||||
print STDERR "Error: Cannot open file $file\n";
|
||||
next;
|
||||
}
|
||||
while (<IN>) {
|
||||
$lineno++;
|
||||
|
||||
if ($state == 0) {
|
||||
if (/$doc_start/o) {
|
||||
$state = 1; # next line is always the function name
|
||||
}
|
||||
} elsif ($state == 1) { # this line is the function name (always)
|
||||
if (/$doc_func/o) {
|
||||
$function = $1;
|
||||
$state = 2;
|
||||
if (/-\s*(.*)/) {
|
||||
$function_purpose = $1;
|
||||
} else {
|
||||
$function_purpose = "";
|
||||
}
|
||||
if ($verbose) {
|
||||
print STDERR "Info($lineno): Scanning doc for $function\n";
|
||||
}
|
||||
} else {
|
||||
print STDERR "warning: $lineno: Cannot understand $_ on line $lineno",
|
||||
" - I thought it was a doc line\n";
|
||||
$state = 0;
|
||||
}
|
||||
} elsif ($state == 2) { # look for head: lines, and include content
|
||||
if (/$doc_sect/o) {
|
||||
$newsection = $1;
|
||||
$newcontents = $2;
|
||||
|
||||
if ($contents ne "") {
|
||||
dump_section($section, $contents);
|
||||
$section = $section_default;
|
||||
}
|
||||
|
||||
$contents = $newcontents;
|
||||
if ($contents ne "") {
|
||||
$contents .= "\n";
|
||||
}
|
||||
$section = $newsection;
|
||||
} elsif (/$doc_end/) {
|
||||
|
||||
if ($contents ne "") {
|
||||
dump_section($section, $contents);
|
||||
$section = $section_default;
|
||||
$contents = "";
|
||||
}
|
||||
|
||||
# print STDERR "end of doc comment, looking for prototype\n";
|
||||
$prototype = "";
|
||||
$state = 3;
|
||||
} elsif (/$doc_content/) {
|
||||
# miguel-style comment kludge, look for blank lines after
|
||||
# @parameter line to signify start of description
|
||||
if ($1 eq "" && $section =~ m/^@/) {
|
||||
dump_section($section, $contents);
|
||||
$section = $section_default;
|
||||
$contents = "";
|
||||
} else {
|
||||
$contents .= $1."\n";
|
||||
}
|
||||
} else {
|
||||
# i dont know - bad line? ignore.
|
||||
print STDERR "warning: $lineno: Bad line: $_";
|
||||
}
|
||||
} elsif ($state == 3) { # scanning for function { (end of prototype)
|
||||
if (m#\s*/\*\s+MACDOC\s*#io) {
|
||||
# do nothing
|
||||
}
|
||||
elsif (/([^\{]*)/) {
|
||||
$prototype .= $1;
|
||||
}
|
||||
if (/\{/) {
|
||||
$prototype =~ s@/\*.*?\*/@@gos; # strip comments.
|
||||
$prototype =~ s@[\r\n]+@ @gos; # strip newlines/cr's.
|
||||
$prototype =~ s@^ +@@gos; # strip leading spaces
|
||||
dump_function($prototype);
|
||||
|
||||
$function = "";
|
||||
%constants = ();
|
||||
%parameters = ();
|
||||
%parametertypes = ();
|
||||
@parameterlist = ();
|
||||
%sections = ();
|
||||
@sectionlist = ();
|
||||
$prototype = "";
|
||||
|
||||
$state = 0;
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
732
doc/gpl.texi
Normal file
732
doc/gpl.texi
Normal file
@@ -0,0 +1,732 @@
|
||||
@node Copying
|
||||
|
||||
@unnumbered GNU General Public License
|
||||
@center Version 3, 29 June 2007
|
||||
|
||||
@c This file is intended to be included in another file.
|
||||
|
||||
@display
|
||||
Copyright @copyright{} 2007 Free Software Foundation, Inc. @url{http://fsf.org/}
|
||||
|
||||
Everyone is permitted to copy and distribute verbatim copies of this
|
||||
license document, but changing it is not allowed.
|
||||
@end display
|
||||
|
||||
@unnumberedsec Preamble
|
||||
|
||||
The GNU General Public License is a free, copyleft license for
|
||||
software and other kinds of works.
|
||||
|
||||
The licenses for most software and other practical works are designed
|
||||
to take away your freedom to share and change the works. By contrast,
|
||||
the GNU General Public License is intended to guarantee your freedom
|
||||
to share and change all versions of a program--to make sure it remains
|
||||
free software for all its users. We, the Free Software Foundation,
|
||||
use the GNU General Public License for most of our software; it
|
||||
applies also to any other work released this way by its authors. You
|
||||
can apply it to your programs, too.
|
||||
|
||||
When we speak of free software, we are referring to freedom, not
|
||||
price. Our General Public Licenses are designed to make sure that you
|
||||
have the freedom to distribute copies of free software (and charge for
|
||||
them if you wish), that you receive source code or can get it if you
|
||||
want it, that you can change the software or use pieces of it in new
|
||||
free programs, and that you know you can do these things.
|
||||
|
||||
To protect your rights, we need to prevent others from denying you
|
||||
these rights or asking you to surrender the rights. Therefore, you
|
||||
have certain responsibilities if you distribute copies of the
|
||||
software, or if you modify it: responsibilities to respect the freedom
|
||||
of others.
|
||||
|
||||
For example, if you distribute copies of such a program, whether
|
||||
gratis or for a fee, you must pass on to the recipients the same
|
||||
freedoms that you received. You must make sure that they, too,
|
||||
receive or can get the source code. And you must show them these
|
||||
terms so they know their rights.
|
||||
|
||||
Developers that use the GNU GPL protect your rights with two steps:
|
||||
(1) assert copyright on the software, and (2) offer you this License
|
||||
giving you legal permission to copy, distribute and/or modify it.
|
||||
|
||||
For the developers' and authors' protection, the GPL clearly explains
|
||||
that there is no warranty for this free software. For both users' and
|
||||
authors' sake, the GPL requires that modified versions be marked as
|
||||
changed, so that their problems will not be attributed erroneously to
|
||||
authors of previous versions.
|
||||
|
||||
Some devices are designed to deny users access to install or run
|
||||
modified versions of the software inside them, although the
|
||||
manufacturer can do so. This is fundamentally incompatible with the
|
||||
aim of protecting users' freedom to change the software. The
|
||||
systematic pattern of such abuse occurs in the area of products for
|
||||
individuals to use, which is precisely where it is most unacceptable.
|
||||
Therefore, we have designed this version of the GPL to prohibit the
|
||||
practice for those products. If such problems arise substantially in
|
||||
other domains, we stand ready to extend this provision to those
|
||||
domains in future versions of the GPL, as needed to protect the
|
||||
freedom of users.
|
||||
|
||||
Finally, every program is threatened constantly by software patents.
|
||||
States should not allow patents to restrict development and use of
|
||||
software on general-purpose computers, but in those that do, we wish
|
||||
to avoid the special danger that patents applied to a free program
|
||||
could make it effectively proprietary. To prevent this, the GPL
|
||||
assures that patents cannot be used to render the program non-free.
|
||||
|
||||
The precise terms and conditions for copying, distribution and
|
||||
modification follow.
|
||||
|
||||
@iftex
|
||||
@unnumberedsec TERMS AND CONDITIONS
|
||||
@end iftex
|
||||
@ifinfo
|
||||
@center TERMS AND CONDITIONS
|
||||
@end ifinfo
|
||||
|
||||
@enumerate 0
|
||||
@item Definitions.
|
||||
|
||||
``This License'' refers to version 3 of the GNU General Public License.
|
||||
|
||||
``Copyright'' also means copyright-like laws that apply to other kinds
|
||||
of works, such as semiconductor masks.
|
||||
|
||||
``The Program'' refers to any copyrightable work licensed under this
|
||||
License. Each licensee is addressed as ``you''. ``Licensees'' and
|
||||
``recipients'' may be individuals or organizations.
|
||||
|
||||
To ``modify'' a work means to copy from or adapt all or part of the work
|
||||
in a fashion requiring copyright permission, other than the making of
|
||||
an exact copy. The resulting work is called a ``modified version'' of
|
||||
the earlier work or a work ``based on'' the earlier work.
|
||||
|
||||
A ``covered work'' means either the unmodified Program or a work based
|
||||
on the Program.
|
||||
|
||||
To ``propagate'' a work means to do anything with it that, without
|
||||
permission, would make you directly or secondarily liable for
|
||||
infringement under applicable copyright law, except executing it on a
|
||||
computer or modifying a private copy. Propagation includes copying,
|
||||
distribution (with or without modification), making available to the
|
||||
public, and in some countries other activities as well.
|
||||
|
||||
To ``convey'' a work means any kind of propagation that enables other
|
||||
parties to make or receive copies. Mere interaction with a user
|
||||
through a computer network, with no transfer of a copy, is not
|
||||
conveying.
|
||||
|
||||
An interactive user interface displays ``Appropriate Legal Notices'' to
|
||||
the extent that it includes a convenient and prominently visible
|
||||
feature that (1) displays an appropriate copyright notice, and (2)
|
||||
tells the user that there is no warranty for the work (except to the
|
||||
extent that warranties are provided), that licensees may convey the
|
||||
work under this License, and how to view a copy of this License. If
|
||||
the interface presents a list of user commands or options, such as a
|
||||
menu, a prominent item in the list meets this criterion.
|
||||
|
||||
@item Source Code.
|
||||
|
||||
The ``source code'' for a work means the preferred form of the work for
|
||||
making modifications to it. ``Object code'' means any non-source form
|
||||
of a work.
|
||||
|
||||
A ``Standard Interface'' means an interface that either is an official
|
||||
standard defined by a recognized standards body, or, in the case of
|
||||
interfaces specified for a particular programming language, one that
|
||||
is widely used among developers working in that language.
|
||||
|
||||
The ``System Libraries'' of an executable work include anything, other
|
||||
than the work as a whole, that (a) is included in the normal form of
|
||||
packaging a Major Component, but which is not part of that Major
|
||||
Component, and (b) serves only to enable use of the work with that
|
||||
Major Component, or to implement a Standard Interface for which an
|
||||
implementation is available to the public in source code form. A
|
||||
``Major Component'', in this context, means a major essential component
|
||||
(kernel, window system, and so on) of the specific operating system
|
||||
(if any) on which the executable work runs, or a compiler used to
|
||||
produce the work, or an object code interpreter used to run it.
|
||||
|
||||
The ``Corresponding Source'' for a work in object code form means all
|
||||
the source code needed to generate, install, and (for an executable
|
||||
work) run the object code and to modify the work, including scripts to
|
||||
control those activities. However, it does not include the work's
|
||||
System Libraries, or general-purpose tools or generally available free
|
||||
programs which are used unmodified in performing those activities but
|
||||
which are not part of the work. For example, Corresponding Source
|
||||
includes interface definition files associated with source files for
|
||||
the work, and the source code for shared libraries and dynamically
|
||||
linked subprograms that the work is specifically designed to require,
|
||||
such as by intimate data communication or control flow between those
|
||||
subprograms and other parts of the work.
|
||||
|
||||
The Corresponding Source need not include anything that users can
|
||||
regenerate automatically from other parts of the Corresponding Source.
|
||||
|
||||
The Corresponding Source for a work in source code form is that same
|
||||
work.
|
||||
|
||||
@item Basic Permissions.
|
||||
|
||||
All rights granted under this License are granted for the term of
|
||||
copyright on the Program, and are irrevocable provided the stated
|
||||
conditions are met. This License explicitly affirms your unlimited
|
||||
permission to run the unmodified Program. The output from running a
|
||||
covered work is covered by this License only if the output, given its
|
||||
content, constitutes a covered work. This License acknowledges your
|
||||
rights of fair use or other equivalent, as provided by copyright law.
|
||||
|
||||
You may make, run and propagate covered works that you do not convey,
|
||||
without conditions so long as your license otherwise remains in force.
|
||||
You may convey covered works to others for the sole purpose of having
|
||||
them make modifications exclusively for you, or provide you with
|
||||
facilities for running those works, provided that you comply with the
|
||||
terms of this License in conveying all material for which you do not
|
||||
control copyright. Those thus making or running the covered works for
|
||||
you must do so exclusively on your behalf, under your direction and
|
||||
control, on terms that prohibit them from making any copies of your
|
||||
copyrighted material outside their relationship with you.
|
||||
|
||||
Conveying under any other circumstances is permitted solely under the
|
||||
conditions stated below. Sublicensing is not allowed; section 10
|
||||
makes it unnecessary.
|
||||
|
||||
@item Protecting Users' Legal Rights From Anti-Circumvention Law.
|
||||
|
||||
No covered work shall be deemed part of an effective technological
|
||||
measure under any applicable law fulfilling obligations under article
|
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or
|
||||
similar laws prohibiting or restricting circumvention of such
|
||||
measures.
|
||||
|
||||
When you convey a covered work, you waive any legal power to forbid
|
||||
circumvention of technological measures to the extent such
|
||||
circumvention is effected by exercising rights under this License with
|
||||
respect to the covered work, and you disclaim any intention to limit
|
||||
operation or modification of the work as a means of enforcing, against
|
||||
the work's users, your or third parties' legal rights to forbid
|
||||
circumvention of technological measures.
|
||||
|
||||
@item Conveying Verbatim Copies.
|
||||
|
||||
You may convey verbatim copies of the Program's source code as you
|
||||
receive it, in any medium, provided that you conspicuously and
|
||||
appropriately publish on each copy an appropriate copyright notice;
|
||||
keep intact all notices stating that this License and any
|
||||
non-permissive terms added in accord with section 7 apply to the code;
|
||||
keep intact all notices of the absence of any warranty; and give all
|
||||
recipients a copy of this License along with the Program.
|
||||
|
||||
You may charge any price or no price for each copy that you convey,
|
||||
and you may offer support or warranty protection for a fee.
|
||||
|
||||
@item Conveying Modified Source Versions.
|
||||
|
||||
You may convey a work based on the Program, or the modifications to
|
||||
produce it from the Program, in the form of source code under the
|
||||
terms of section 4, provided that you also meet all of these
|
||||
conditions:
|
||||
|
||||
@enumerate a
|
||||
@item
|
||||
The work must carry prominent notices stating that you modified it,
|
||||
and giving a relevant date.
|
||||
|
||||
@item
|
||||
The work must carry prominent notices stating that it is released
|
||||
under this License and any conditions added under section 7. This
|
||||
requirement modifies the requirement in section 4 to ``keep intact all
|
||||
notices''.
|
||||
|
||||
@item
|
||||
You must license the entire work, as a whole, under this License to
|
||||
anyone who comes into possession of a copy. This License will
|
||||
therefore apply, along with any applicable section 7 additional terms,
|
||||
to the whole of the work, and all its parts, regardless of how they
|
||||
are packaged. This License gives no permission to license the work in
|
||||
any other way, but it does not invalidate such permission if you have
|
||||
separately received it.
|
||||
|
||||
@item
|
||||
If the work has interactive user interfaces, each must display
|
||||
Appropriate Legal Notices; however, if the Program has interactive
|
||||
interfaces that do not display Appropriate Legal Notices, your work
|
||||
need not make them do so.
|
||||
@end enumerate
|
||||
|
||||
A compilation of a covered work with other separate and independent
|
||||
works, which are not by their nature extensions of the covered work,
|
||||
and which are not combined with it such as to form a larger program,
|
||||
in or on a volume of a storage or distribution medium, is called an
|
||||
``aggregate'' if the compilation and its resulting copyright are not
|
||||
used to limit the access or legal rights of the compilation's users
|
||||
beyond what the individual works permit. Inclusion of a covered work
|
||||
in an aggregate does not cause this License to apply to the other
|
||||
parts of the aggregate.
|
||||
|
||||
@item Conveying Non-Source Forms.
|
||||
|
||||
You may convey a covered work in object code form under the terms of
|
||||
sections 4 and 5, provided that you also convey the machine-readable
|
||||
Corresponding Source under the terms of this License, in one of these
|
||||
ways:
|
||||
|
||||
@enumerate a
|
||||
@item
|
||||
Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by the
|
||||
Corresponding Source fixed on a durable physical medium customarily
|
||||
used for software interchange.
|
||||
|
||||
@item
|
||||
Convey the object code in, or embodied in, a physical product
|
||||
(including a physical distribution medium), accompanied by a written
|
||||
offer, valid for at least three years and valid for as long as you
|
||||
offer spare parts or customer support for that product model, to give
|
||||
anyone who possesses the object code either (1) a copy of the
|
||||
Corresponding Source for all the software in the product that is
|
||||
covered by this License, on a durable physical medium customarily used
|
||||
for software interchange, for a price no more than your reasonable
|
||||
cost of physically performing this conveying of source, or (2) access
|
||||
to copy the Corresponding Source from a network server at no charge.
|
||||
|
||||
@item
|
||||
Convey individual copies of the object code with a copy of the written
|
||||
offer to provide the Corresponding Source. This alternative is
|
||||
allowed only occasionally and noncommercially, and only if you
|
||||
received the object code with such an offer, in accord with subsection
|
||||
6b.
|
||||
|
||||
@item
|
||||
Convey the object code by offering access from a designated place
|
||||
(gratis or for a charge), and offer equivalent access to the
|
||||
Corresponding Source in the same way through the same place at no
|
||||
further charge. You need not require recipients to copy the
|
||||
Corresponding Source along with the object code. If the place to copy
|
||||
the object code is a network server, the Corresponding Source may be
|
||||
on a different server (operated by you or a third party) that supports
|
||||
equivalent copying facilities, provided you maintain clear directions
|
||||
next to the object code saying where to find the Corresponding Source.
|
||||
Regardless of what server hosts the Corresponding Source, you remain
|
||||
obligated to ensure that it is available for as long as needed to
|
||||
satisfy these requirements.
|
||||
|
||||
@item
|
||||
Convey the object code using peer-to-peer transmission, provided you
|
||||
inform other peers where the object code and Corresponding Source of
|
||||
the work are being offered to the general public at no charge under
|
||||
subsection 6d.
|
||||
|
||||
@end enumerate
|
||||
|
||||
A separable portion of the object code, whose source code is excluded
|
||||
from the Corresponding Source as a System Library, need not be
|
||||
included in conveying the object code work.
|
||||
|
||||
A ``User Product'' is either (1) a ``consumer product'', which means any
|
||||
tangible personal property which is normally used for personal,
|
||||
family, or household purposes, or (2) anything designed or sold for
|
||||
incorporation into a dwelling. In determining whether a product is a
|
||||
consumer product, doubtful cases shall be resolved in favor of
|
||||
coverage. For a particular product received by a particular user,
|
||||
``normally used'' refers to a typical or common use of that class of
|
||||
product, regardless of the status of the particular user or of the way
|
||||
in which the particular user actually uses, or expects or is expected
|
||||
to use, the product. A product is a consumer product regardless of
|
||||
whether the product has substantial commercial, industrial or
|
||||
non-consumer uses, unless such uses represent the only significant
|
||||
mode of use of the product.
|
||||
|
||||
``Installation Information'' for a User Product means any methods,
|
||||
procedures, authorization keys, or other information required to
|
||||
install and execute modified versions of a covered work in that User
|
||||
Product from a modified version of its Corresponding Source. The
|
||||
information must suffice to ensure that the continued functioning of
|
||||
the modified object code is in no case prevented or interfered with
|
||||
solely because modification has been made.
|
||||
|
||||
If you convey an object code work under this section in, or with, or
|
||||
specifically for use in, a User Product, and the conveying occurs as
|
||||
part of a transaction in which the right of possession and use of the
|
||||
User Product is transferred to the recipient in perpetuity or for a
|
||||
fixed term (regardless of how the transaction is characterized), the
|
||||
Corresponding Source conveyed under this section must be accompanied
|
||||
by the Installation Information. But this requirement does not apply
|
||||
if neither you nor any third party retains the ability to install
|
||||
modified object code on the User Product (for example, the work has
|
||||
been installed in ROM).
|
||||
|
||||
The requirement to provide Installation Information does not include a
|
||||
requirement to continue to provide support service, warranty, or
|
||||
updates for a work that has been modified or installed by the
|
||||
recipient, or for the User Product in which it has been modified or
|
||||
installed. Access to a network may be denied when the modification
|
||||
itself materially and adversely affects the operation of the network
|
||||
or violates the rules and protocols for communication across the
|
||||
network.
|
||||
|
||||
Corresponding Source conveyed, and Installation Information provided,
|
||||
in accord with this section must be in a format that is publicly
|
||||
documented (and with an implementation available to the public in
|
||||
source code form), and must require no special password or key for
|
||||
unpacking, reading or copying.
|
||||
|
||||
@item Additional Terms.
|
||||
|
||||
``Additional permissions'' are terms that supplement the terms of this
|
||||
License by making exceptions from one or more of its conditions.
|
||||
Additional permissions that are applicable to the entire Program shall
|
||||
be treated as though they were included in this License, to the extent
|
||||
that they are valid under applicable law. If additional permissions
|
||||
apply only to part of the Program, that part may be used separately
|
||||
under those permissions, but the entire Program remains governed by
|
||||
this License without regard to the additional permissions.
|
||||
|
||||
When you convey a copy of a covered work, you may at your option
|
||||
remove any additional permissions from that copy, or from any part of
|
||||
it. (Additional permissions may be written to require their own
|
||||
removal in certain cases when you modify the work.) You may place
|
||||
additional permissions on material, added by you to a covered work,
|
||||
for which you have or can give appropriate copyright permission.
|
||||
|
||||
Notwithstanding any other provision of this License, for material you
|
||||
add to a covered work, you may (if authorized by the copyright holders
|
||||
of that material) supplement the terms of this License with terms:
|
||||
|
||||
@enumerate a
|
||||
@item
|
||||
Disclaiming warranty or limiting liability differently from the terms
|
||||
of sections 15 and 16 of this License; or
|
||||
|
||||
@item
|
||||
Requiring preservation of specified reasonable legal notices or author
|
||||
attributions in that material or in the Appropriate Legal Notices
|
||||
displayed by works containing it; or
|
||||
|
||||
@item
|
||||
Prohibiting misrepresentation of the origin of that material, or
|
||||
requiring that modified versions of such material be marked in
|
||||
reasonable ways as different from the original version; or
|
||||
|
||||
@item
|
||||
Limiting the use for publicity purposes of names of licensors or
|
||||
authors of the material; or
|
||||
|
||||
@item
|
||||
Declining to grant rights under trademark law for use of some trade
|
||||
names, trademarks, or service marks; or
|
||||
|
||||
@item
|
||||
Requiring indemnification of licensors and authors of that material by
|
||||
anyone who conveys the material (or modified versions of it) with
|
||||
contractual assumptions of liability to the recipient, for any
|
||||
liability that these contractual assumptions directly impose on those
|
||||
licensors and authors.
|
||||
@end enumerate
|
||||
|
||||
All other non-permissive additional terms are considered ``further
|
||||
restrictions'' within the meaning of section 10. If the Program as you
|
||||
received it, or any part of it, contains a notice stating that it is
|
||||
governed by this License along with a term that is a further
|
||||
restriction, you may remove that term. If a license document contains
|
||||
a further restriction but permits relicensing or conveying under this
|
||||
License, you may add to a covered work material governed by the terms
|
||||
of that license document, provided that the further restriction does
|
||||
not survive such relicensing or conveying.
|
||||
|
||||
If you add terms to a covered work in accord with this section, you
|
||||
must place, in the relevant source files, a statement of the
|
||||
additional terms that apply to those files, or a notice indicating
|
||||
where to find the applicable terms.
|
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the
|
||||
form of a separately written license, or stated as exceptions; the
|
||||
above requirements apply either way.
|
||||
|
||||
@item Termination.
|
||||
|
||||
You may not propagate or modify a covered work except as expressly
|
||||
provided under this License. Any attempt otherwise to propagate or
|
||||
modify it is void, and will automatically terminate your rights under
|
||||
this License (including any patent licenses granted under the third
|
||||
paragraph of section 11).
|
||||
|
||||
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, you do not qualify to receive new licenses for the same
|
||||
material under section 10.
|
||||
|
||||
@item Acceptance Not Required for Having Copies.
|
||||
|
||||
You are not required to accept this License in order to receive or run
|
||||
a copy of the Program. Ancillary propagation of a covered work
|
||||
occurring solely as a consequence of using peer-to-peer transmission
|
||||
to receive a copy likewise does not require acceptance. However,
|
||||
nothing other than this License grants you permission to propagate or
|
||||
modify any covered work. These actions infringe copyright if you do
|
||||
not accept this License. Therefore, by modifying or propagating a
|
||||
covered work, you indicate your acceptance of this License to do so.
|
||||
|
||||
@item Automatic Licensing of Downstream Recipients.
|
||||
|
||||
Each time you convey a covered work, the recipient automatically
|
||||
receives a license from the original licensors, to run, modify and
|
||||
propagate that work, subject to this License. You are not responsible
|
||||
for enforcing compliance by third parties with this License.
|
||||
|
||||
An ``entity transaction'' is a transaction transferring control of an
|
||||
organization, or substantially all assets of one, or subdividing an
|
||||
organization, or merging organizations. If propagation of a covered
|
||||
work results from an entity transaction, each party to that
|
||||
transaction who receives a copy of the work also receives whatever
|
||||
licenses to the work the party's predecessor in interest had or could
|
||||
give under the previous paragraph, plus a right to possession of the
|
||||
Corresponding Source of the work from the predecessor in interest, if
|
||||
the predecessor has it or can get it with reasonable efforts.
|
||||
|
||||
You may not impose any further restrictions on the exercise of the
|
||||
rights granted or affirmed under this License. For example, you may
|
||||
not impose a license fee, royalty, or other charge for exercise of
|
||||
rights granted under this License, and you may not initiate litigation
|
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that
|
||||
any patent claim is infringed by making, using, selling, offering for
|
||||
sale, or importing the Program or any portion of it.
|
||||
|
||||
@item Patents.
|
||||
|
||||
A ``contributor'' is a copyright holder who authorizes use under this
|
||||
License of the Program or a work on which the Program is based. The
|
||||
work thus licensed is called the contributor's ``contributor version''.
|
||||
|
||||
A contributor's ``essential patent claims'' are all patent claims owned
|
||||
or controlled by the contributor, whether already acquired or
|
||||
hereafter acquired, that would be infringed by some manner, permitted
|
||||
by this License, of making, using, or selling its contributor version,
|
||||
but do not include claims that would be infringed only as a
|
||||
consequence of further modification of the contributor version. For
|
||||
purposes of this definition, ``control'' includes the right to grant
|
||||
patent sublicenses in a manner consistent with the requirements of
|
||||
this License.
|
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free
|
||||
patent license under the contributor's essential patent claims, to
|
||||
make, use, sell, offer for sale, import and otherwise run, modify and
|
||||
propagate the contents of its contributor version.
|
||||
|
||||
In the following three paragraphs, a ``patent license'' is any express
|
||||
agreement or commitment, however denominated, not to enforce a patent
|
||||
(such as an express permission to practice a patent or covenant not to
|
||||
sue for patent infringement). To ``grant'' such a patent license to a
|
||||
party means to make such an agreement or commitment not to enforce a
|
||||
patent against the party.
|
||||
|
||||
If you convey a covered work, knowingly relying on a patent license,
|
||||
and the Corresponding Source of the work is not available for anyone
|
||||
to copy, free of charge and under the terms of this License, through a
|
||||
publicly available network server or other readily accessible means,
|
||||
then you must either (1) cause the Corresponding Source to be so
|
||||
available, or (2) arrange to deprive yourself of the benefit of the
|
||||
patent license for this particular work, or (3) arrange, in a manner
|
||||
consistent with the requirements of this License, to extend the patent
|
||||
license to downstream recipients. ``Knowingly relying'' means you have
|
||||
actual knowledge that, but for the patent license, your conveying the
|
||||
covered work in a country, or your recipient's use of the covered work
|
||||
in a country, would infringe one or more identifiable patents in that
|
||||
country that you have reason to believe are valid.
|
||||
|
||||
If, pursuant to or in connection with a single transaction or
|
||||
arrangement, you convey, or propagate by procuring conveyance of, a
|
||||
covered work, and grant a patent license to some of the parties
|
||||
receiving the covered work authorizing them to use, propagate, modify
|
||||
or convey a specific copy of the covered work, then the patent license
|
||||
you grant is automatically extended to all recipients of the covered
|
||||
work and works based on it.
|
||||
|
||||
A patent license is ``discriminatory'' if it does not include within the
|
||||
scope of its coverage, prohibits the exercise of, or is conditioned on
|
||||
the non-exercise of one or more of the rights that are specifically
|
||||
granted under this License. You may not convey a covered work if you
|
||||
are a party to an arrangement with a third party that is in the
|
||||
business of distributing software, under which you make payment to the
|
||||
third party based on the extent of your activity of conveying the
|
||||
work, and under which the third party grants, to any of the parties
|
||||
who would receive the covered work from you, a discriminatory patent
|
||||
license (a) in connection with copies of the covered work conveyed by
|
||||
you (or copies made from those copies), or (b) primarily for and in
|
||||
connection with specific products or compilations that contain the
|
||||
covered work, unless you entered into that arrangement, or that patent
|
||||
license was granted, prior to 28 March 2007.
|
||||
|
||||
Nothing in this License shall be construed as excluding or limiting
|
||||
any implied license or other defenses to infringement that may
|
||||
otherwise be available to you under applicable patent law.
|
||||
|
||||
@item No Surrender of Others' Freedom.
|
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or
|
||||
otherwise) that contradict the conditions of this License, they do not
|
||||
excuse you from the conditions of this License. If you cannot convey
|
||||
a covered work so as to satisfy simultaneously your obligations under
|
||||
this License and any other pertinent obligations, then as a
|
||||
consequence you may not convey it at all. For example, if you agree
|
||||
to terms that obligate you to collect a royalty for further conveying
|
||||
from those to whom you convey the Program, the only way you could
|
||||
satisfy both those terms and this License would be to refrain entirely
|
||||
from conveying the Program.
|
||||
|
||||
@item Use with the GNU Affero General Public License.
|
||||
|
||||
Notwithstanding any other provision of this License, you have
|
||||
permission to link or combine any covered work with a work licensed
|
||||
under version 3 of the GNU Affero General Public License into a single
|
||||
combined work, and to convey the resulting work. The terms of this
|
||||
License will continue to apply to the part which is the covered work,
|
||||
but the special requirements of the GNU Affero General Public License,
|
||||
section 13, concerning interaction through a network will apply to the
|
||||
combination as such.
|
||||
|
||||
@item Revised Versions of this License.
|
||||
|
||||
The Free Software Foundation may publish revised and/or new versions
|
||||
of the GNU General Public 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.
|
||||
|
||||
Each version is given a distinguishing version number. If the Program
|
||||
specifies that a certain numbered version of the GNU General Public
|
||||
License ``or any later version'' applies to it, you have the option of
|
||||
following the terms and conditions either of that numbered version or
|
||||
of any later version published by the Free Software Foundation. If
|
||||
the Program does not specify a version number of the GNU General
|
||||
Public License, you may choose any version ever published by the Free
|
||||
Software Foundation.
|
||||
|
||||
If the Program specifies that a proxy can decide which future versions
|
||||
of the GNU General Public License can be used, that proxy's public
|
||||
statement of acceptance of a version permanently authorizes you to
|
||||
choose that version for the Program.
|
||||
|
||||
Later license versions may give you additional or different
|
||||
permissions. However, no additional obligations are imposed on any
|
||||
author or copyright holder as a result of your choosing to follow a
|
||||
later version.
|
||||
|
||||
@item Disclaimer of Warranty.
|
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
|
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
|
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM ``AS IS'' WITHOUT
|
||||
WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT
|
||||
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
|
||||
A PARTICULAR PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND
|
||||
PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE PROGRAM PROVE
|
||||
DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR OR
|
||||
CORRECTION.
|
||||
|
||||
@item Limitation of Liability.
|
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
|
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR
|
||||
CONVEYS THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
|
||||
INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES
|
||||
ARISING OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT
|
||||
NOT LIMITED TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR
|
||||
LOSSES SUSTAINED BY YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM
|
||||
TO OPERATE WITH ANY OTHER PROGRAMS), EVEN IF SUCH HOLDER OR OTHER
|
||||
PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES.
|
||||
|
||||
@item Interpretation of Sections 15 and 16.
|
||||
|
||||
If the disclaimer of warranty and limitation of liability provided
|
||||
above cannot be given local legal effect according to their terms,
|
||||
reviewing courts shall apply local law that most closely approximates
|
||||
an absolute waiver of all civil liability in connection with the
|
||||
Program, unless a warranty or assumption of liability accompanies a
|
||||
copy of the Program in return for a fee.
|
||||
|
||||
@end enumerate
|
||||
|
||||
@iftex
|
||||
@heading END OF TERMS AND CONDITIONS
|
||||
@end iftex
|
||||
@ifinfo
|
||||
@center END OF TERMS AND CONDITIONS
|
||||
@end ifinfo
|
||||
|
||||
@unnumberedsec How to Apply These Terms to Your New Programs
|
||||
|
||||
If you develop a new program, and you want it to be of the greatest
|
||||
possible use to the public, the best way to achieve this is to make it
|
||||
free software which everyone can redistribute and change under these
|
||||
terms.
|
||||
|
||||
To do so, attach the following notices to the program. It is safest
|
||||
to attach them to the start of each source file to most effectively
|
||||
state the exclusion of warranty; and each file should have at least
|
||||
the ``copyright'' line and a pointer to where the full notice is
|
||||
found.
|
||||
|
||||
@example
|
||||
@var{one line to give the program's name and a brief idea of what it does.}
|
||||
Copyright (C) @var{year} @var{name of author}
|
||||
|
||||
This program is free software: you can redistribute it and/or modify
|
||||
it under the terms of the GNU General Public License as published by
|
||||
the Free Software Foundation, either version 3 of the License, or (at
|
||||
your option) any later version.
|
||||
|
||||
This program is distributed in the hope that it will be useful, but
|
||||
WITHOUT ANY WARRANTY; without even the implied warranty of
|
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
|
||||
General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU General Public License
|
||||
along with this program. If not, see @url{http://www.gnu.org/licenses/}.
|
||||
@end example
|
||||
|
||||
@noindent
|
||||
Also add information on how to contact you by electronic and paper mail.
|
||||
|
||||
@noindent
|
||||
If the program does terminal interaction, make it output a short
|
||||
notice like this when it starts in an interactive mode:
|
||||
|
||||
@smallexample
|
||||
@var{program} Copyright (C) @var{year} @var{name of author}
|
||||
This program comes with ABSOLUTELY NO WARRANTY; for details
|
||||
type @samp{show w}. This is free software, and you are
|
||||
welcome to redistribute it under certain conditions;
|
||||
type @samp{show c} for details.
|
||||
@end smallexample
|
||||
|
||||
The hypothetical commands @samp{show w} and @samp{show c} should show
|
||||
the appropriate parts of the General Public License. Of course, your
|
||||
program's commands might be different; for a GUI interface, you would
|
||||
use an ``about box''.
|
||||
|
||||
You should also get your employer (if you work as a programmer) or school,
|
||||
if any, to sign a ``copyright disclaimer'' for the program, if necessary.
|
||||
For more information on this, and how to apply and follow the GNU GPL, see
|
||||
@url{http://www.gnu.org/licenses/}.
|
||||
|
||||
The GNU General Public License does not permit incorporating your
|
||||
program into proprietary programs. If your program is a subroutine
|
||||
library, you may consider it more useful to permit linking proprietary
|
||||
applications with the library. If this is what you want to do, use
|
||||
the GNU Lesser General Public License instead of this License. But
|
||||
first, please read @url{http://www.gnu.org/philosophy/why-not-lgpl.html}.
|
||||
Reference in New Issue
Block a user