elf
/
bigfcc
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Big Fast Class Generator for C++, initial check-in to git (from CVS, no less).

This commit is contained in:
Elf M. Sternberg 2010-10-25 17:09:58 -07:00
commit 7d1fbc4930
12 changed files with 1878 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
.gitignore vendored Normal file
View File

@ -0,0 +1,6 @@
*.pyc
*.pyo
*#
.#*
.DS_Store
*~

5
AUTHORS Normal file
View File

@ -0,0 +1,5 @@
Elf M. Sternberg <elf@drizzle.com>
Thanks to John F. Hubbard for the initial design and C++ implementation,
and special thanks for his permission to release the Python version
under the GPL.

340
COPYING Normal file
View File

@ -0,0 +1,340 @@
GNU GENERAL PUBLIC LICENSE
Version 2, June 1991
Copyright (C) 1989, 1991 Free Software Foundation, Inc.
59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble
The licenses for most software are designed to take away your
freedom to share and change it. By contrast, the GNU General Public
License is intended to guarantee your freedom to share and change free
software--to make sure the software is free for all its users. This
General Public License applies to most of the Free Software
Foundation's software and to any other program whose authors commit to
using it. (Some other Free Software Foundation software is covered by
the GNU Library General Public License instead.) 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
this service 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 make restrictions that forbid
anyone to deny you these rights or to ask you to surrender the rights.
These restrictions translate to certain responsibilities for you if you
distribute copies of the software, or if you modify it.
For example, if you distribute copies of such a program, whether
gratis or for a fee, you must give the recipients all the rights that
you have. 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.
We protect your rights with two steps: (1) copyright the software, and
(2) offer you this license which gives you legal permission to copy,
distribute and/or modify the software.
Also, for each author's protection and ours, we want to make certain
that everyone understands that there is no warranty for this free
software. If the software is modified by someone else and passed on, we
want its recipients to know that what they have is not the original, so
that any problems introduced by others will not reflect on the original
authors' reputations.
Finally, any free program is threatened constantly by software
patents. We wish to avoid the danger that redistributors of a free
program will individually obtain patent licenses, in effect making the
program proprietary. To prevent this, we have made it clear that any
patent must be licensed for everyone's free use or not licensed at all.
The precise terms and conditions for copying, distribution and
modification follow.
GNU GENERAL PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. This License applies to any program or other work which contains
a notice placed by the copyright holder saying it may be distributed
under the terms of this General Public License. The "Program", below,
refers to any such program or work, and a "work based on the Program"
means either the Program or any derivative work under copyright law:
that is to say, a work containing the Program or a portion of it,
either verbatim or with modifications and/or translated into another
language. (Hereinafter, translation is included without limitation in
the term "modification".) Each licensee is addressed as "you".
Activities other than copying, distribution and modification are not
covered by this License; they are outside its scope. The act of
running the Program is not restricted, and the output from the Program
is covered only if its contents constitute a work based on the
Program (independent of having been made by running the Program).
Whether that is true depends on what the Program does.
1. You may copy and distribute 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 and disclaimer of warranty; keep intact all the
notices that refer to this License and to the absence of any warranty;
and give any other recipients of the Program a copy of this License
along with the Program.
You may charge a fee for the physical act of transferring a copy, and
you may at your option offer warranty protection in exchange for a fee.
2. You may modify your copy or copies of the Program or any portion
of it, thus forming a work based on the Program, and copy and
distribute such modifications or work under the terms of Section 1
above, provided that you also meet all of these conditions:
a) You must cause the modified files to carry prominent notices
stating that you changed the files and the date of any change.
b) You must cause any work that you distribute or publish, that in
whole or in part contains or is derived from the Program or any
part thereof, to be licensed as a whole at no charge to all third
parties under the terms of this License.
c) If the modified program normally reads commands interactively
when run, you must cause it, when started running for such
interactive use in the most ordinary way, to print or display an
announcement including an appropriate copyright notice and a
notice that there is no warranty (or else, saying that you provide
a warranty) and that users may redistribute the program under
these conditions, and telling the user how to view a copy of this
License. (Exception: if the Program itself is interactive but
does not normally print such an announcement, your work based on
the Program is not required to print an announcement.)
These requirements apply to the modified work as a whole. If
identifiable sections of that work are not derived from the Program,
and can be reasonably considered independent and separate works in
themselves, then this License, and its terms, do not apply to those
sections when you distribute them as separate works. But when you
distribute the same sections as part of a whole which is a work based
on the Program, the distribution of the whole must be on the terms of
this License, whose permissions for other licensees extend to the
entire whole, and thus to each and every part regardless of who wrote it.
Thus, it is not the intent of this section to claim rights or contest
your rights to work written entirely by you; rather, the intent is to
exercise the right to control the distribution of derivative or
collective works based on the Program.
In addition, mere aggregation of another work not based on the Program
with the Program (or with a work based on the Program) on a volume of
a storage or distribution medium does not bring the other work under
the scope of this License.
3. You may copy and distribute the Program (or a work based on it,
under Section 2) in object code or executable form under the terms of
Sections 1 and 2 above provided that you also do one of the following:
a) Accompany it with the complete corresponding machine-readable
source code, which must be distributed under the terms of Sections
1 and 2 above on a medium customarily used for software interchange; or,
b) Accompany it with a written offer, valid for at least three
years, to give any third party, for a charge no more than your
cost of physically performing source distribution, a complete
machine-readable copy of the corresponding source code, to be
distributed under the terms of Sections 1 and 2 above on a medium
customarily used for software interchange; or,
c) Accompany it with the information you received as to the offer
to distribute corresponding source code. (This alternative is
allowed only for noncommercial distribution and only if you
received the program in object code or executable form with such
an offer, in accord with Subsection b above.)
The source code for a work means the preferred form of the work for
making modifications to it. For an executable work, complete source
code means all the source code for all modules it contains, plus any
associated interface definition files, plus the scripts used to
control compilation and installation of the executable. However, as a
special exception, the source code distributed need not include
anything that is normally distributed (in either source or binary
form) with the major components (compiler, kernel, and so on) of the
operating system on which the executable runs, unless that component
itself accompanies the executable.
If distribution of executable or object code is made by offering
access to copy from a designated place, then offering equivalent
access to copy the source code from the same place counts as
distribution of the source code, even though third parties are not
compelled to copy the source along with the object code.
4. You may not copy, modify, sublicense, or distribute the Program
except as expressly provided under this License. Any attempt
otherwise to copy, modify, sublicense or distribute the Program is
void, and will automatically terminate your rights under this License.
However, parties who have received copies, or rights, from you under
this License will not have their licenses terminated so long as such
parties remain in full compliance.
5. You are not required to accept this License, since you have not
signed it. However, nothing else grants you permission to modify or
distribute the Program or its derivative works. These actions are
prohibited by law if you do not accept this License. Therefore, by
modifying or distributing the Program (or any work based on the
Program), you indicate your acceptance of this License to do so, and
all its terms and conditions for copying, distributing or modifying
the Program or works based on it.
6. Each time you redistribute the Program (or any work based on the
Program), the recipient automatically receives a license from the
original licensor to copy, distribute or modify the Program subject to
these terms and conditions. You may not impose any further
restrictions on the recipients' exercise of the rights granted herein.
You are not responsible for enforcing compliance by third parties to
this License.
7. If, as a consequence of a court judgment or allegation of patent
infringement or for any other reason (not limited to patent issues),
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
distribute so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you
may not distribute the Program at all. For example, if a patent
license would not permit royalty-free redistribution of the Program by
all those who receive copies directly or indirectly through you, then
the only way you could satisfy both it and this License would be to
refrain entirely from distribution of the Program.
If any portion of this section is held invalid or unenforceable under
any particular circumstance, the balance of the section is intended to
apply and the section as a whole is intended to apply in other
circumstances.
It is not the purpose of this section to induce you to infringe any
patents or other property right claims or to contest validity of any
such claims; this section has the sole purpose of protecting the
integrity of the free software distribution system, which is
implemented by public license practices. Many people have made
generous contributions to the wide range of software distributed
through that system in reliance on consistent application of that
system; it is up to the author/donor to decide if he or she is willing
to distribute software through any other system and a licensee cannot
impose that choice.
This section is intended to make thoroughly clear what is believed to
be a consequence of the rest of this License.
8. If the distribution and/or use of the Program is restricted in
certain countries either by patents or by copyrighted interfaces, the
original copyright holder who places the Program under this License
may add an explicit geographical distribution limitation excluding
those countries, so that distribution is permitted only in or among
countries not thus excluded. In such case, this License incorporates
the limitation as if written in the body of this License.
9. The Free Software Foundation may publish revised and/or new versions
of the 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 a version number of this License which applies to it and "any
later version", you have the option of following the terms and conditions
either of that version or of any later version published by the Free
Software Foundation. If the Program does not specify a version number of
this License, you may choose any version ever published by the Free Software
Foundation.
10. If you wish to incorporate parts of the Program into other free
programs whose distribution conditions are different, write to the author
to ask for permission. For software which is copyrighted by the Free
Software Foundation, write to the Free Software Foundation; we sometimes
make exceptions for this. Our decision will be guided by the two goals
of preserving the free status of all derivatives of our free software and
of promoting the sharing and reuse of software generally.
NO WARRANTY
11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, 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.
12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
REDISTRIBUTE 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.
END OF TERMS AND CONDITIONS
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
convey the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.
<one line to give the program's name and a brief idea of what it does.>
Copyright (C) <year> <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 2 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, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
Also add information on how to contact you by electronic and paper mail.
If the program is interactive, make it output a short notice like this
when it starts in an interactive mode:
Gnomovision version 69, Copyright (C) year name of author
Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.
The hypothetical commands `show w' and `show c' should show the appropriate
parts of the General Public License. Of course, the commands you use may
be called something other than `show w' and `show c'; they could even be
mouse-clicks or menu items--whatever suits your program.
You should also get your employer (if you work as a programmer) or your
school, if any, to sign a "copyright disclaimer" for the program, if
necessary. Here is a sample; alter the names:
Yoyodyne, Inc., hereby disclaims all copyright interest in the program
`Gnomovision' (which makes passes at compilers) written by James Hacker.
<signature of Ty Coon>, 1 April 1989
Ty Coon, President of Vice
This 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 Library General
Public License instead of this License.

6
INSTALL Normal file
View File

@ -0,0 +1,6 @@
Basic Installation
==================
bigfcc.py is a simple python script. Just put it somewhere in your path
and run it. You may have to modify the first line to point to your
python executable.

18
Makefile Normal file
View File

@ -0,0 +1,18 @@
FILES = AUTHORS COPYING INSTALL README TODO \
bigfcc.py bigfcc_man.tex Makefile
TARFILES = ${FILES} bigfcc_man.html bigfcc.1 bigfcc.man
bigfcc_man.html: bigfcc_man.tex
latex2man -H bigfcc_man.tex bigfcc_man.html
bigfcc.1: bigfcc_man.tex
latex2man bigfcc_man.tex bigfcc.1
bigfcc.man: bigfcc.1
nroff -Tascii -man bigfcc.1 > bigfcc.man
all: ${TARFILES}
archive: all
tar cvf - ${TARFILES} | gzip -9c > bigfcc.tar.gz

14
README Normal file
View File

@ -0,0 +1,14 @@
This is a distribution of bigfcc.py, a C++ Class Framework generator
* Licensing
This program is released under the terms of the GNU General Public
License (GNU GPL).
You can find a copy of the license in the file COPYING.
* Using:
Bigfcc comes with a complete list of commands that can be seen by
running the command with no arguments. See the man page that comes
with it.

1
TODO Normal file
View File

@ -0,0 +1 @@
Templates do not work correctly as yet.

229
bigfcc.1 Normal file
View File

@ -0,0 +1,229 @@
'\" t
.\" Manual page created with latex2man on Thu Oct 11 15:40:18 PDT 2001
.\" NOTE: This file is generated, DO NOT EDIT.
.de Vb
.ft CW
.nf
..
.de Ve
.ft R
.fi
..
.TH "FCC" "1" "11 October 2001" "C++ Development Tools "
.SH NAME
.PP
fcc
is a tool to rapidly generate the basic framework of C++
class and components. fcc
can generate inline files, testing
components, and basic copyright notices.
.PP
.SH SYNOPSIS
.PP
fcc
\fB\-class \fP\fIlist of class names\fP
\fB\-author \fP\fIauthor\&'s name\fP
[\fB\-namespace \fP\fInamespace_name\fP]
[\fB\-overwrite\fP]
[\fB\-verbose\fP]
[\fB\-no_unit_test\fP]
[\fB\-no_makefile\fP]
[\fB\-project \fP\fIproject_name\fP]
[\fB\-sccs_keywords\fP]
[\fB\-continuus_keywords\fP]
[\fB\-open_source_notice\fP]
[\fB\-copyright \fP[\fIcopyright\fP]]
[\fB\-base_filename \fP\fIbase_filename\fP]
[\fB\-no_copy_ctor\fP]
[\fB\-no_assignment_operator\fP]
[\fB\-no_ctor\fP]
[\fB\-no_dtor\fP]
[\fB\-public_copy_ctor\fP]
[\fB\-public_assignment_operator\fP]
[\fB\-no_dump_diagnostics\fP]
[\fB\-no_check_valid\fP]
[\fB\-no_icc\fP]
[\fB\-settings_file \fP\fIfilename\fP]
.PP
.SH DESCRIPTION
fcc
takes the name of one or more classes and generates the
appropriate code and header files for those classes. By default, it
includes a constructor, destructor, private copy constructor, private
assignment operator, unit testing, and appropriate inlines. It also
generates a raw BSD\-style makefile.
.PP
.SH OPTIONS
.TP
\fB\-class \fP\fIlist of class names\fP
Names of classes to be
generated. The files will be named after the first class name on the
list. Class names must be separated by whitespace.
.PP
.TP
\fB\-author \fP\fIauthor\&'s name\fP
Your name here.
.PP
.TP
\fB\-namespace \fP\fInamespace name\fP
Wrap the output in a
specified namespace.
.PP
.TP
\fB\-verbose\fP
Explain in excruciating detail what the program
is doing.
.PP
.TP
\fB\-no_unit_test\fP
Do not generate unit\-testing definitions in
the source files. This is an empty method; it\&'s up to the user to
define appropriate tests.
.PP
.TP
\fB\-no_makefile\fP
Do not generate a makefile for this code.
.PP
.TP
\fB\-project \fP\fIproject_name\fP
Define a project for this makefile. Right now
this option does nothing.
.PP
.TP
\fB\-sccs_keywords\fP
Generate IDs appropriate to SCCS.
.PP
.TP
\fB\-continuus_keywords\fP
Generate keywords for the Continuus
Version System.
.PP
.TP
\fB\-open_source_notice\fP
Add some comments about how this code
is open source and permission to copy in granted yadda yadda...
.PP
.TP
\fB\-copyright \fP[\fIcopyright\fP]
Adds your copyright notice to the
code.
.PP
.TP
\fB\-base_filename \fP\fIbase_filename\fP
Set the name of the
files output. Defaults to first class name listed if not set.
.PP
.TP
\fB\-no_copy_ctor\fP
Do not provide a copy constructor in the
output code.
.PP
.TP
\fB\-no_assignment_operator\fP
Do not provide an assignment
operator in the output code.
.PP
.TP
\fB\-no_ctor\fP
Do not provide a default constructor in the
output code.
.PP
.TP
\fB\-no_dtor\fP
Do not provide a destructor in the output code.
.PP
.TP
\fB\-public_copy_ctor\fP
Put the copy constructor in the public
section instead of the private section.
.PP
.TP
\fB\-public_assignment_operator\fP
Put the assignment operator in
the public section instead of the private section.
.PP
.TP
\fB\-no_dump_diagnostics\fP
Do not provide a debugging method.
.PP
.TP
\fB\-no_check_valid\fP
Do not provide a Programming By Contract
style method to check for invariants.
.PP
.TP
\fB\-no_icc\fP
Do not provide a file for class inlines.
.PP
.TP
\fB\-settings_file \fP\fIfilename\fP
Get options from a settings
file. Right now this option does nothing.
.PP
.SH REQUIREMENTS
.PP
.RS
.TP
Python
fcc
requires Python version >= 2.0
.RE
.RS
.PP
.SH VERSION
Version: 0.8a of May 5, 2001
.PP
.SH LICENSE AND COPYRIGHT
.PP
.RS
.RE
.TP
Copyright
(C)2001, Elf M. Sternberg
.br
\fBelf@drizzle.com\fP
.br
\fBhttp://www.drizzle.com/ elf\fP
.RS
.PP
.RE
.TP
License
This program can be redistributed and/or modified under the
terms of the GNU Public License. See the file COPYING or visit
\fBhttp://www.gnu.org/copyleft/gpl.html\fP
for terms of use and
distribution.
.RS
.PP
.RE
.TP
Misc
If you find this software useful, please drop me some email
.RS
.PP
.RE
.TP
Misc
This man page was generated using latex2man by Dr. Jurgen
Vollmer, and is available from the CTAN archives.
.RE
.RS
.PP
.SH AUTHOR
.PP
Elf M. Sternberg
.br
Email: \fBelf@drizzle.com\fP
.br
WWW: \fBhttp://www.drizzle.com/ elf\fP\&.
.\" NOTE: This file is generated, DO NOT EDIT.

264
bigfcc.man Normal file
View File

@ -0,0 +1,264 @@
FCC(1) FCC(1)
NNAAMMEE
fcc is a tool to rapidly generate the basic framework of
C++ class and components. fcc can generate inline files,
testing components, and basic copyright notices.
SSYYNNOOPPSSIISS
fcc --ccllaassss _l_i_s_t _o_f _c_l_a_s_s _n_a_m_e_s --aauutthhoorr _a_u_t_h_o_r_'_s _n_a_m_e
[--nnaammeessppaaccee _n_a_m_e_s_p_a_c_e___n_a_m_e] [--oovveerrwwrriittee] [--vveerrbboossee]
[--nnoo__uunniitt__tteesstt] [--nnoo__mmaakkeeffiillee] [--pprroojjeecctt _p_r_o_j_e_c_t___n_a_m_e]
[--ssccccss__kkeeyywwoorrddss] [--ccoonnttiinnuuuuss__kkeeyywwoorrddss]
[--ooppeenn__ssoouurrccee__nnoottiiccee] [--ccooppyyrriigghhtt [_c_o_p_y_r_i_g_h_t]]
[--bbaassee__ffiilleennaammee _b_a_s_e___f_i_l_e_n_a_m_e] [--nnoo__ccooppyy__ccttoorr]
[--nnoo__aassssiiggnnmmeenntt__ooppeerraattoorr] [--nnoo__ccttoorr] [--nnoo__ddttoorr] [--ppuubb--
lliicc__ccooppyy__ccttoorr] [--ppuubblliicc__aassssiiggnnmmeenntt__ooppeerraattoorr]
[--nnoo__dduummpp__ddiiaaggnnoossttiiccss] [--nnoo__cchheecckk__vvaalliidd] [--nnoo__iicccc] [--sseett--
ttiinnggss__ffiillee _f_i_l_e_n_a_m_e]
DDEESSCCRRIIPPTTIIOONN
fcc takes the name of one or more classes and generates
the appropriate code and header files for those classes.
By default, it includes a constructor, destructor, private
copy constructor, private assignment operator, unit test-
ing, and appropriate inlines. It also generates a raw
BSD-style makefile.
OOPPTTIIOONNSS
--ccllaassss _l_i_s_t _o_f _c_l_a_s_s _n_a_m_e_s
Names of classes to be generated. The files will
be named after the first class name on the list.
Class names must be separated by whitespace.
--aauutthhoorr _a_u_t_h_o_r_'_s _n_a_m_e
Your name here.
--nnaammeessppaaccee _n_a_m_e_s_p_a_c_e _n_a_m_e
Wrap the output in a specified namespace.
--vveerrbboossee
Explain in excruciating detail what the program is
doing.
--nnoo__uunniitt__tteesstt
Do not generate unit-testing definitions in the
source files. This is an empty method; it's up to
the user to define appropriate tests.
C++ Development Tools 11 October 2001 1
FCC(1) FCC(1)
--nnoo__mmaakkeeffiillee
Do not generate a makefile for this code.
--pprroojjeecctt _p_r_o_j_e_c_t___n_a_m_e
Define a project for this makefile. Right now this
option does nothing.
--ssccccss__kkeeyywwoorrddss
Generate IDs appropriate to SCCS.
--ccoonnttiinnuuuuss__kkeeyywwoorrddss
Generate keywords for the Continuus Version Sys-
tem.
--ooppeenn__ssoouurrccee__nnoottiiccee
Add some comments about how this code is open
source and permission to copy in granted yadda
yadda...
--ccooppyyrriigghhtt [_c_o_p_y_r_i_g_h_t]
Adds your copyright notice to the code.
--bbaassee__ffiilleennaammee _b_a_s_e___f_i_l_e_n_a_m_e
Set the name of the files output. Defaults to
first class name listed if not set.
--nnoo__ccooppyy__ccttoorr
Do not provide a copy constructor in the output
code.
--nnoo__aassssiiggnnmmeenntt__ooppeerraattoorr
Do not provide an assignment operator in the out-
put code.
--nnoo__ccttoorr
Do not provide a default constructor in the output
code.
--nnoo__ddttoorr
Do not provide a destructor in the output code.
--ppuubblliicc__ccooppyy__ccttoorr
Put the copy constructor in the public section
C++ Development Tools 11 October 2001 2
FCC(1) FCC(1)
instead of the private section.
--ppuubblliicc__aassssiiggnnmmeenntt__ooppeerraattoorr
Put the assignment operator in the public section
instead of the private section.
--nnoo__dduummpp__ddiiaaggnnoossttiiccss
Do not provide a debugging method.
--nnoo__cchheecckk__vvaalliidd
Do not provide a Programming By Contract style
method to check for invariants.
--nnoo__iicccc
Do not provide a file for class inlines.
--sseettttiinnggss__ffiillee _f_i_l_e_n_a_m_e
Get options from a settings file. Right now this
option does nothing.
RREEQQUUIIRREEMMEENNTTSS
Python fcc requires Python version >= 2.0
VVEERRSSIIOONN
Version: 0.8a of May 5, 2001
LLIICCEENNSSEE AANNDD CCOOPPYYRRIIGGHHTT
Copyright
(C)2001, Elf M. Sternberg
eellff@@ddrriizzzzllee..ccoomm
hhttttpp::////wwwwww..ddrriizzzzllee..ccoomm// eellff
License
This program can be redistributed and/or modified
under the terms of the GNU Public License. See the
file COPYING or visit hhttttpp::////wwwwww..ggnnuu..oorrgg//ccooppyy--
lleefftt//ggppll..hhttmmll for terms of use and distribution.
Misc If you find this software useful, please drop me
some email
Misc This man page was generated using latex2man by Dr.
Jurgen Vollmer, and is available from the CTAN
C++ Development Tools 11 October 2001 3
FCC(1) FCC(1)
archives.
AAUUTTHHOORR
Elf M. Sternberg
Email: eellff@@ddrriizzzzllee..ccoomm
WWW: hhttttpp::////wwwwww..ddrriizzzzllee..ccoomm// eellff.
C++ Development Tools 11 October 2001 4

596
bigfcc.py Normal file
View File

@ -0,0 +1,596 @@
#!/usr/local/bin/python
from StringIO import StringIO
import string
import sys
import time
class WriteSentry:
'''
Purpose: WriteSentry encapsulates the way an output file is written
to. It also provides a convenient way to open, write to, and close
a file, merely by declaring a WriteSentry object in a given Python
scope. When the WriteSentry object goes out of scope, the __del__
method is called, and the file is flushed and closed.
'''
VERBOSE = 1;
OVERWRITE = 2;
def __init__( self, fileName, mode, reallyCreate = 1 ):
mode = mode or self.VERBOSE
self.outputFile = None
if reallyCreate:
bCreateTheFile = ( mode & self.OVERWRITE ) != 0
if not bCreateTheFile:
try:
fd = open( fileName, "r" );
self.outputFile = open( "/dev/null", "w" )
if ( mode & self.VERBOSE ):
print "Did NOT create " + fileName + " because it already exists."
fd.close
except:
bCreateTheFile = 1;
if bCreateTheFile:
try:
self.outputFile = open( fileName, "w" )
if ( mode & self.VERBOSE ):
print "Created " + fileName + "\n"
except IOError, e:
print "Could not create file " + str( e )
raise
def __del__( self ):
if self.outputFile != None:
self.outputFile.close()
def getStream( self ):
return self.outputFile
class DigestedCommands:
usage = \
"*******************************************************************************\n" + \
"Fast Class Creator Version 2.35b, Created by John F. Hubbard, 20 April 2001\n" + \
"Ported to Python 13 May 2001 by Elf M. Sternberg\n\n" + \
"Usage: fcc -class <list_of_class_names> (see example below)\n" + \
" -author <authors_name> \n" + \
" [-namespace <namespace_name> | -ns <namespace_name>]\n" + \
" [-overwrite | -ow]\n" + \
" [-verbose | -v]\n" + \
" [-no_unit_test | -no_ut]\n" + \
" [-no_makefile | -no_mf]\n" + \
" [-project <project_name>]\n" + \
" [-sccs_keywords | -sccs]\n" + \
" [-continuus_keywords | -ct]\n" + \
" [-open_source_notice | -os]\n" + \
" [-copyright <copyright> | -c <copyright>]\n" + \
" [-base_filename <base_filename> | -file <base_filename>]\n" + \
" [-no_copy_ctor]\n" + \
" [-no_assignment_operator | -no_op =]\n" + \
" [-no_ctor]\n" + \
" [-no_dtor]\n" + \
" [-public_copy_ctor]\n" + \
" [-public_assignment_operator | -pub_op =]\n" + \
" [-no_dump_diagnostics | -no_dd]\n" + \
" [-no_check_valid | -no_cv]\n" + \
" [-no_icc]\n" + \
" [-settings_file <filename>]\n\n" + \
"Abbreviations: ctor = constructor, dtor = destructor\n\n" + \
"A simple example:\n\n" + \
" fcc -verbose -class Airplane -namespace airport -author \"John F. Hubbard\"\n\n" + \
"This example generates several classes in the same set of FruitFiles.xxx files:\n\n" + \
" fcc -file FruitFiles -class Apple Orange Pear " + \
"-ns fruits -author \"John F. Hubbard\"\n\n" + \
"*******************************************************************************\n\n"
def __init__( self, arglist = sys.argv[1:] ):
j = 0
self.arglist = arglist
self.argkeys = {}
for i in arglist:
self.argkeys[i] = j
j = j + 1
if not ( self.argkeys.has_key( "-class" ) and self.argkeys.has_key( "-author" ) ):
raise self.usage
self.classList = self.getArgument( "-class" )
self.author = self.getArgument( "-author" )
# Added to support multiple classes per file, and control of copy/assignment:
self.sccsKeywords = ( self.argkeys.has_key( "-sccs_keywords" ) or
self.argkeys.has_key( "-sccs" ) )
self.continuousKeywords = ( self.argkeys.has_key( "-continuus_keywords" ) or
self.argkeys.has_key( "-ct" ) )
self.openSourceNotice = ( self.argkeys.has_key( "-open_source_notice" ) or
self.argkeys.has_key( "-os" ) )
if self.argkeys.has_key( "-copyright" ):
self.copyright = self.getArgument( "-copyright" )
elif self.argkeys.has_key( "-c" ):
self.copyright = self.getArgument( "-c" )
else:
self.copyright = \
" * Put Your Copyright Notice here\n"
self.createUnitTestFile = not ( self.argkeys.has_key( "-no_unit_test" ) or
self.argkeys.has_key( "-no_ut" ) )
self.createMakefile = not ( self.argkeys.has_key( "-no_makefile" ) or
self.argkeys.has_key( "-no_mf" ) )
self.ctor = not self.argkeys.has_key( "-no_ctor" )
self.dtor = not self.argkeys.has_key( "-no_dtor" )
self.iccFile = not self.argkeys.has_key( "-no_icc" )
self.checkValid = not ( self.argkeys.has_key( "-no_check_valid" ) or
self.argkeys.has_key( "-no_cv" ) )
self.dumpDiagnostics = not ( self.argkeys.has_key( "-no_dump_diagnostics" ) or
self.argkeys.has_key( "-no_dd" ) )
self.useNamespace = self.argkeys.has_key( "-namespace" ) or self.argkeys.has_key( "-ns" )
self.dtor = not self.argkeys.has_key( "-no_dtor" )
self.copyCtor = self.ctor and not self.argkeys.has_key( "-no_copy_ctor" )
self.assignmentOperator = not ( self.argkeys.has_key( "-no_assignment_operator" ) or
self.argkeys.has_key( "-no_op =" ) )
self.publicCopyCtor = self.argkeys.has_key( "-public_copy_ctor" ) and self.copyCtor
self.publicAssignmentOperator = self.assignmentOperator and \
( self.argkeys.has_key( "-public_assignment_operator" ) or
self.argkeys.has_key( "-pub_op =" ) )
self.writeSentryMode = 0
if ( self.argkeys.has_key( "-verbose" ) or self.argkeys.has_key( "-v" ) ):
self.writeSentryMode = self.writeSentryMode | WriteSentry.VERBOSE
if ( self.argkeys.has_key( "-overwrite" ) or self.argkeys.has_key( "-ow" ) ):
self.writeSentryMode = self.writeSentryMode | WriteSentry.OVERWRITE
if self.argkeys.has_key( "-project" ):
self.projectName = self.getArgument( "-project" );
if self.argkeys.has_key( "-namespace" ):
self.namespace = self.getArgument( "-namespace" );
elif self.argkeys.has_key( "-ns" ):
self.namespace = self.getArgument( "-ns" );
self.classNames = self.getArglist( "-class" )
if self.argkeys.has_key( "-base_filename" ):
self.baseFilename = self.getArgument( "-base_filename" );
elif self.argkeys.has_key( "-file" ):
self.baseFilename = self.getArgument( "-file" )
else:
self.baseFilename = self.classNames[0]
self.headerFile = self.baseFilename + ".h"
self.implFile = self.baseFilename + ".cpp"
self.inlineFile = self.baseFilename + ".icc"
self.makefile = "makefile"
self.unitTestFile = "ut" + self.baseFilename + ".cpp"
def getArgument( self, arg ):
loc = self.argkeys[ arg ] + 1
rep = self.arglist[ loc ]
if string.find( rep, "-" ) == 0:
raise self.usage
return rep
def getArglist( self, arg ):
loc = self.argkeys[ arg ] + 1
rep = []
while( ( loc < len( self.arglist ) ) and
( string.find( self.arglist[ loc ], "-" ) == -1 ) ):
rep.append( self.arglist[ loc ] )
loc = loc + 1
if ( len( rep ) == 0 ):
raise self.usage
return rep
class CodeGenerator:
def __init__( self, commands ):
self.commands = commands
def genCommentHeader( self ):
pass
def genPreface( self ):
pass
def genCodeBody( self, className ):
pass
def genEpilogue( self ):
pass
def generateDefaultCommentHeader( self, fileName, io_str ):
print >> self.getStream(), \
"/*****************************************************************************\n" + \
" *\n" + \
" * " + fileName + "\n" + \
" * Created by " + self.commands.author + ", on " + dateStamp() + "\n" + \
" *\n" + \
" * " + self.commands.copyright + "\n" + \
" *\n",
if self.commands.openSourceNotice:
print >> self.getStream(), \
" * Permission is granted to use this code without restriction,\n" + \
" * as long as this copyright notice appears in all source files.\n" + \
" *\n",
print >> self.getStream(), io_str.getvalue(),
if self.commands.continuousKeywords:
print >> self.getStream(), \
" * %version: 1 %\n" + \
" * %date_modified: " + dateStamp() + " %\n" + \
" * %created_by: " + self.commands.author + " %\n",
if self.commands.sccsKeywords:
print >> self.getStream(), \
" * Version: %I%\n" + \
" * Date modified: %G%\n" + \
" *\n"
print >> self.getStream(), \
" *****************************************************************************\n" + \
" */\n\n",
def generateDefaultPreface( self, fileName, io_str ):
print >> self.getStream(), \
"#include <string>\n" + \
"#include <iostream>\n" + \
"#include \"" + self.commands.headerFile + "\"\n",
print >> self.getStream(), io_str.getvalue()
def createUniqueName( self ):
if self.commands.useNamespace:
return string.upper(self.commands.namespace) + "_" + \
string.upper(self.commands.baseFilename) + "_H"
else:
return string.upper(self.commands.baseFilename) + "_H"
def dateStamp():
return time.asctime( time.localtime( time.time() ) )
class HeaderFileGen( CodeGenerator ):
def __init__( self, commands ):
self.commands = commands
self.writer = WriteSentry( self.commands.headerFile,
self.commands.writeSentryMode )
def getStream( self ):
return self.writer.getStream()
def genCommentHeader( self ):
io_str = StringIO()
print >> io_str, " *\n" + \
" * File Contents: Interface and documentation of the " + \
self.commands.baseFilename + " component.\n" + \
" *\n",
self.generateDefaultCommentHeader( self.commands.headerFile, io_str )
def genPreface( self ):
print >> self.getStream(), \
"#ifndef " + self.createUniqueName() + "\n" + \
"#define " + self.createUniqueName() + "\n\n",
if self.commands.useNamespace:
print >> self.getStream(), \
"namespace " + self.commands.namespace + "\n" + \
"{\n" + \
" \n",
def genCodeBody(self, className ):
print >> self.getStream(), "/** Purpose: TODO: Describe the purpose of the class.\n" + \
" * (Everything that you write here will show up in the\n" + \
" * doc++ generated documentation.)\n" + \
" */\n" + \
"class " + className + "\n" + \
"{\n" + \
"public:\n",
if self.commands.ctor:
print >> self.getStream(), " /// Constructor.\n" + \
" " + className + "();\n\n",
if self.commands.dtor:
print >> self.getStream(), " /// Destructor.\n" + \
" virtual ~" + className + "();\n",
if self.commands.checkValid:
print >> self.getStream(), " \n" + \
" /// CheckValid() is designed to check the class invariants.\n" + \
" inline CheckValid() const;\n",
if self.commands.dumpDiagnostics:
print >> self.getStream(), " \n" + \
" /// DumpDiagnostics() dumps the object's state to standard output.\n" + \
" DumpDiagnostics() const;\n" + \
" \n",
if self.commands.publicCopyCtor:
print >> self.getStream(), "public:\n" + \
" // TODO: Provide an implementation for the copy constructor:\n" + \
" " + className + "(const " + className + "&);\n\n",
elif self.commands.copyCtor:
print >> self.getStream(), "private:\n" + \
" // Copying of this class is prohibited:\n" + \
" " + className + "(const " + className + "&);\n\n",
if self.commands.publicAssignmentOperator:
print >> self.getStream(), "public:\n" + \
" // TODO: Provide an implementation for the assignment operator:\n" + \
" " + className + "& operator=(const " + className + "&);\n\n",
elif self.commands.assignmentOperator:
print >> self.getStream(), "private:\n" + \
" // Assignment to this class is prohibited:\n" + \
" " + className + "& operator=(const " + className + "&);\n\n",
print >> self.getStream(), "};\n",
def genEpilogue( self ):
if self.commands.iccFile:
print >> self.getStream(), " \n" + \
"#include \"" + self.commands.inlineFile + "\"\n",
if self.commands.useNamespace:
print >> self.getStream(), "} // end of the " + self.commands.namespace + " namespace\n\n",
print >> self.getStream(), "#endif /* " + self.createUniqueName() + " */\n\n",
class ImplFileGen( CodeGenerator ):
def __init__( self, commands ):
self.commands = commands
self.writer = WriteSentry( self.commands.implFile,
self.commands.writeSentryMode)
def getStream( self ):
return self.writer.getStream()
def genCommentHeader( self ):
io_str = StringIO()
print >> io_str, " *\n" + \
" * File Contents: Implementation of the " + self.commands.baseFilename + " component.\n" + \
" * Please see " + self.commands.headerFile + " for full documentation of this system.\n" + \
" *\n",
self.generateDefaultCommentHeader( self.commands.implFile, io_str )
def genPreface( self ):
io_str = StringIO()
self.generateDefaultPreface( self.commands.implFile, io_str )
if ( self.commands.useNamespace ):
print >> self.getStream(), "namespace " + self.commands.namespace + "\n" + \
"{\n" + \
" \n"
def genCodeBody( self, className ):
if self.commands.ctor :
print >> self.getStream(), \
className + "::" + className + "()\n" + \
"{\n" + \
"}\n"
if self.commands.dtor:
print >> self.getStream(), className + "::~" + \
className + "()\n" + \
"{\n" + \
"}\n"
if self.commands.dumpDiagnostics:
print >> self.getStream(), "void\n" + \
className + "::DumpDiagnostics() const\n" + \
"{\n",
print >> self.getStream(), ' std::cout << std::endl << std::endl << \n' + \
" \"" + className + \
" Diagnostics dump \"<< std::endl << std::endl;\n",
print >> self.getStream(), "}\n"
def genEpilogue( self ):
if self.commands.useNamespace:
print >> self.getStream(), \
" \n" + \
"} // end of the " + self.commands.namespace + " namespace"
class InlineFileGen( CodeGenerator ):
def __init__( self, commands ):
self.commands = commands
self.writer = WriteSentry( commands.inlineFile, commands.writeSentryMode )
def getStream( self ):
return self.writer.getStream()
def genCommentHeader( self ):
io_str = StringIO()
print >> io_str, " *\n" + \
" * File Contents: Inline definitions for the " + self.commands.baseFilename + \
" component.\n" + \
" * Please see " + self.commands.headerFile + " for full documentation of this class.\n" + \
" *\n",
self.generateDefaultCommentHeader( self.commands.inlineFile, io_str );
def genCodeBody( self, className ):
if self.commands.checkValid:
print >> self.getStream(), "inline void\n" + \
className + "::CheckValid() const\n" + \
"{\n" + \
" // TODO: Fill in with class invariant assertions for " + \
className + ".\n" + \
"}\n"
class MakefileGen( CodeGenerator ):
def __init__( self, commands ):
self.commands = commands
self.writer = WriteSentry( self.commands.makefile,
self.commands.writeSentryMode,
self.commands.createMakefile )
def getStream( self ):
return self.writer.getStream()
def genCommentHeader( self ):
print >> self.getStream(), \
"#########################################################################\n" + \
"# " + self.commands.makefile + "\n" + \
"# Created by " + self.commands.author + " on " + dateStamp() + "\n" + \
"#\n" + \
"# File Contents: makefile for the " + self.commands.baseFilename + " component.\n" + \
"#\n" + \
"#########################################################################\n\n"
def genPreface( self ):
print >> self.getStream(), "NAME=" + self.commands.baseFilename
print >> self.getStream(), "INCLUDES=\n" + \
"LIBS=\n" + \
"CC=gcc\n" + \
"CXX=g++\n" + \
"LD=g++\n" + \
"LD_FLAGS=\n\n" + \
"all: ut${NAME} html\n\n" + \
"html: ${NAME}.h \n" + \
"\tdoc++ -d html *.h\n" + \
"\ttouch html\n\n" + \
"CXX_FLAGS=-DLINUX -g -c -fhonor-std \\\n" + \
" -fno-builtin -D_REENTRANT -Wall -Wno-unknown-pragmas -Wno-unused\n\n" + \
"ut${NAME} : ut${NAME}.o ${NAME}.o\n" + \
"\t${LINK} ${LINK_FLAGS} -o ut${NAME} ut${NAME}.o ${NAME}.o ${LIBS}\n\n" + \
"${NAME}.o : ${NAME}.cpp ${NAME}.h",
if self.commands.iccFile:
print >> self.getStream(), " ${NAME}.icc",
print >> self.getStream(), "\n" + \
"\t${CXX} ${CXX_FLAGS} ${INCLUDES} -c -o ${NAME}.o ${NAME}.cpp\n\n" + \
"ut${NAME}.o : ut${NAME}.cpp ${NAME}.h",
if self.commands.iccFile:
print >> self.getStream(), " ${NAME}.icc",
print >> self.getStream(), "\n" + \
"\t${CXX} ${CXX_FLAGS} ${INCLUDES} -c -o ut${NAME}.o ut${NAME}.cpp\n\n" + \
"clean:\n" + \
"\trm *.o ut${NAME} html/" "*\n" + \
"\trmdir html"
class UnitTestFileGen(CodeGenerator):
def __init__( self, commands ):
self.commands = commands
self.writer = WriteSentry( self.commands.unitTestFile,
self.commands.writeSentryMode,
self.commands.createUnitTestFile )
def genCommentHeader( self ):
io_str = StringIO()
print >> io_str, " *\n" + \
" * File Contents: Unit test for the the " + self.commands.baseFilename +" component.\n" + \
" * Please see " + self.commands.headerFile +" for full documentation of this class.\n" + \
" *\n"
self.generateDefaultCommentHeader( self.commands.unitTestFile, io_str )
def genPreface( self ):
io_str = StringIO()
self.generateDefaultPreface( self.commands.unitTestFile, io_str )
print >> self.getStream(), "int main(int argc, char* argv[])\n" + \
"{\n"
def genCodeBody( self, className ):
if self.commands.useNamespace:
print >> self.getStream(), " " + self.commands.namespace +"::"
print >>self.getStream(), className +" obj" + className +";\n"
if self.commands.dumpDiagnostics:
print >> self.getStream(), " obj" + className +".DumpDiagnostics();\n"
print >> self.getStream(), "\n"
def genEpilogue( self ):
print >> self.getStream(), " return 0;\n" + \
"}\n"
def getStream( self ):
return self.writer.getStream()
class ClassCreator:
def __init__( self, commands ):
self.commands = commands
def generateCode( self ):
self.generateFile( HeaderFileGen )
self.generateFile( ImplFileGen )
if self.commands.iccFile:
self.generateFile( InlineFileGen )
if self.commands.createMakefile:
self.generateFile( MakefileGen )
if self.commands.createUnitTestFile:
self.generateFile( UnitTestFileGen )
def generateFile( self, inclass ):
generator = inclass( self.commands )
generator.genCommentHeader(); # The comment header with author, description, etc.
generator.genPreface(); # #ifdef directives, for example.
for i in self.commands.classNames:
generator.genCodeBody( i ); # generate each class.
generator.genEpilogue();
commands = DigestedCommands( )
creator = ClassCreator( commands )
creator.generateCode()

232
bigfcc_man.html Normal file
View File

@ -0,0 +1,232 @@
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
<!-- Manual page created with latex2man on Thu Oct 11 15:40:11 PDT 2001 --
-- Author of latex2man: Juergen.Vollmer@acm.org --
-- NOTE: This file is generated, DO NOT EDIT. -->
<html>
<head><title>FCC</title></head>
<body bgcolor="white">
<h1 align=center>
fcc -<br>
Fast Class Generator
</h1>
<h4 align=center>Elf M. Sternberg </h4>
<h4 align=center>11 October 2001</h4>
<h4 align=center>Version 0.8a</h4>
<p>
<tt>fcc</tt>
is a tool to rapidly generate the basic framework of C++
class and components. <tt>fcc</tt>
can generate inline files, testing
components, and basic copyright notices.
<p>
<h3>Table of Contents</h3>
<ul>
<li><a href="#section_1">Synopsis </a></li>
<li><a href="#section_2">Description </a></li>
<li><a href="#section_3">Options </a></li>
<li><a href="#section_4">Requirements </a></li>
<li><a href="#section_5">Version </a></li>
<li><a href="#section_6">License and Copyright </a></li>
<li><a href="#section_7">Author </a>
</li></ul>
<p>
<h2><a name="section_1">Synopsis</a></h2>
<p>
<tt>fcc</tt>
<b>-class </b><i>list of class names</i>
<b>-author </b><i>author's name</i>
[<b>-namespace </b><i>namespace_name</i>]
[<b>-overwrite</b>]
[<b>-verbose</b>]
[<b>-no_unit_test</b>]
[<b>-no_makefile</b>]
[<b>-project </b><i>project_name</i>]
[<b>-sccs_keywords</b>]
[<b>-continuus_keywords</b>]
[<b>-open_source_notice</b>]
[<b>-copyright </b>[<i>copyright</i>]]
[<b>-base_filename </b><i>base_filename</i>]
[<b>-no_copy_ctor</b>]
[<b>-no_assignment_operator</b>]
[<b>-no_ctor</b>]
[<b>-no_dtor</b>]
[<b>-public_copy_ctor</b>]
[<b>-public_assignment_operator</b>]
[<b>-no_dump_diagnostics</b>]
[<b>-no_check_valid</b>]
[<b>-no_icc</b>]
[<b>-settings_file </b><i>filename</i>]
<p>
<h2><a name="section_2">Description</a></h2>
<tt>fcc</tt>
takes the name of one or more classes and generates the
appropriate code and header files for those classes. By default, it
includes a constructor, destructor, private copy constructor, private
assignment operator, unit testing, and appropriate inlines. It also
generates a raw BSD-style makefile.
<p>
<h2><a name="section_3">Options</a></h2>
<dl compact>
<dt><b>-class </b><i>list of class names</i>
<dd> Names of classes to be
generated. The files will be named after the first class name on the
list. Class names must be separated by whitespace.
<p>
</dd>
<dt><b>-author </b><i>author's name</i>
<dd> Your name here.
<p>
</dd>
<dt><b>-namespace </b><i>namespace name</i>
<dd> Wrap the output in a
specified namespace.
<p>
</dd>
<dt><b>-verbose</b>
<dd> Explain in excruciating detail what the program
is doing.
<p>
</dd>
<dt><b>-no_unit_test</b>
<dd> Do not generate unit-testing definitions in
the source files. This is an empty method; it's up to the user to
define appropriate tests.
<p>
</dd>
<dt><b>-no_makefile</b>
<dd> Do not generate a makefile for this code.
<p>
</dd>
<dt><b>-project </b><i>project_name</i>
<dd> Define a project for this makefile. Right now
this option does nothing.
<p>
</dd>
<dt><b>-sccs_keywords</b>
<dd> Generate IDs appropriate to SCCS.
<p>
</dd>
<dt><b>-continuus_keywords</b>
<dd> Generate keywords for the Continuus
Version System.
<p>
</dd>
<dt><b>-open_source_notice</b>
<dd> Add some comments about how this code
is open source and permission to copy in granted yadda yadda...
<p>
</dd>
<dt><b>-copyright </b>[<i>copyright</i>]
<dd> Adds your copyright notice to the
code.
<p>
</dd>
<dt><b>-base_filename </b><i>base_filename</i>
<dd> Set the name of the
files output. Defaults to first class name listed if not set.
<p>
</dd>
<dt><b>-no_copy_ctor</b>
<dd> Do not provide a copy constructor in the
output code.
<p>
</dd>
<dt><b>-no_assignment_operator</b>
<dd> Do not provide an assignment
operator in the output code.
<p>
</dd>
<dt><b>-no_ctor</b>
<dd> Do not provide a default constructor in the
output code.
<p>
</dd>
<dt><b>-no_dtor</b>
<dd> Do not provide a destructor in the output code.
<p>
</dd>
<dt><b>-public_copy_ctor</b>
<dd> Put the copy constructor in the public
section instead of the private section.
<p>
</dd>
<dt><b>-public_assignment_operator</b>
<dd> Put the assignment operator in
the public section instead of the private section.
<p>
</dd>
<dt><b>-no_dump_diagnostics</b>
<dd> Do not provide a debugging method.
<p>
</dd>
<dt><b>-no_check_valid</b>
<dd> Do not provide a Programming By Contract
style method to check for invariants.
<p>
</dd>
<dt><b>-no_icc</b>
<dd> Do not provide a file for class inlines.
<p>
</dd>
<dt><b>-settings_file </b><i>filename</i>
<dd> Get options from a settings
file. Right now this option does nothing.
<p>
<h2><a name="section_4">Requirements</a></h2>
<p>
<dl compact>
<dt>Python
<dd> <tt>fcc</tt>
requires Python version &gt;= 2.0
</dd>
</dl>
<p>
<h2><a name="section_5">Version</a></h2>
Version: 0.8a of May 5, 2001
<p>
<h2><a name="section_6">License and Copyright</a></h2>
<p>
<dl compact>
<dt>Copyright
<dd> &copy; 2001, Elf M. Sternberg <br>
<a href ="mailto:elf@drizzle.com"><tt>elf@drizzle.com</tt></a>
<br>
<a href ="http://www.drizzle.com/&nbsp;elf"><tt>http://www.drizzle.com/&nbsp;elf</tt></a>
<p>
</dd>
<dt>License
<dd> This program can be redistributed and/or modified under the
terms of the GNU Public License. See the file COPYING or visit
<a href ="http://www.gnu.org/copyleft/gpl.html"><tt>http://www.gnu.org/copyleft/gpl.html</tt></a>
for terms of use and
distribution.
<p>
</dd>
<dt>Misc
<dd> If you find this software useful, please drop me some email
<p>
</dd>
<dt>Misc
<dd> This man page was generated using latex2man by Dr. Jurgen
Vollmer, and is available from the CTAN archives.
</dd>
</dl>
<p>
<h2><a name="section_7">Author</a></h2>
<p>
Elf M. Sternberg <br>
Email: <a href ="mailto:elf@drizzle.com"><tt>elf@drizzle.com</tt></a>
<br>
WWW: <a href ="http://www.drizzle.com/&nbsp;elf"><tt>http://www.drizzle.com/&nbsp;elf</tt></a>.
</body>
</html>
<!-- NOTE: This file is generated, DO NOT EDIT. -->

167
bigfcc_man.tex Normal file
View File

@ -0,0 +1,167 @@
\documentclass[english]{article}
\usepackage[latin1]{inputenc}
\usepackage{babel}
\IfFileExists{fancyhdr.sty}{
\usepackage[fancyhdr,pdf]{latex2man}
}{
\IfFileExists{fancyheadings.sty}{
\usepackage[fancy,pdf]{latex2man}
}{
\usepackage[nofancy,pdf]{latex2man}
\message{no fancyhdr or fancyheadings package present, discard it}
}}
\setVersionWord{Version:}
\setVersion{0.8a}
\begin{document}
\begin{Name}{1}{fcc}{Elf M. Sternberg}{C++ Development Tools}{fcc\\--\\ Fast Class Generator}
\Prog{fcc} is a tool to rapidly generate the basic framework of C++
class and components. \Prog{fcc} can generate inline files, testing
components, and basic copyright notices.
\end{Name}
\section{Synopsis}
%%%%%%%%%%%%%%%%%%
\Prog{fcc} \OptArg{-class }{list of class names}
\OptArg{-author }{author's name}
\oOptArg{-namespace }{namespace_name}
\oOpt{-overwrite}
\oOpt{-verbose}
\oOpt{-no_unit_test}
\oOpt{-no_makefile}
\oOptArg{-project }{project_name}
\oOpt{-sccs_keywords}
\oOpt{-continuus_keywords}
\oOpt{-open_source_notice}
\oOptoArg{-copyright }{copyright}
\oOptArg{-base_filename }{base_filename}
\oOpt{-no_copy_ctor}
\oOpt{-no_assignment_operator}
\oOpt{-no_ctor}
\oOpt{-no_dtor}
\oOpt{-public_copy_ctor}
\oOpt{-public_assignment_operator}
\oOpt{-no_dump_diagnostics}
\oOpt{-no_check_valid}
\oOpt{-no_icc}
\oOptArg{-settings_file }{filename}
\section{Description}
%%%%%%%%%%%%%%%%%%%%%
\Prog{fcc} takes the name of one or more classes and generates the
appropriate code and header files for those classes. By default, it
includes a constructor, destructor, private copy constructor, private
assignment operator, unit testing, and appropriate inlines. It also
generates a raw BSD-style makefile.
\section{Options}
%%%%%%%%%%%%%%%%%
\begin{Description}
\item[\OptArg{-class }{list of class names}] Names of classes to be
generated. The files will be named after the first class name on the
list. Class names must be separated by whitespace.
\item[\OptArg{-author }{author's name}] Your name here.
\item[\OptArg{-namespace }{namespace name}] Wrap the output in a
specified namespace.
\item[\Opt{-verbose}] Explain in excruciating detail what the program
is doing.
\item[\Opt{-no_unit_test}] Do not generate unit-testing definitions in
the source files. This is an empty method; it's up to the user to
define appropriate tests.
\item[\Opt{-no_makefile}] Do not generate a makefile for this code.
\item[\OptArg{-project }{project_name}] Define a project for this makefile. Right now
this option does nothing.
\item[\Opt{-sccs_keywords}] Generate IDs appropriate to SCCS.
\item[\Opt{-continuus_keywords}] Generate keywords for the Continuus
Version System.
\item[\Opt{-open_source_notice}] Add some comments about how this code
is open source and permission to copy in granted yadda yadda...
\item[\OptoArg{-copyright }{copyright}] Adds your copyright notice to the
code.
\item[\OptArg{-base_filename }{base_filename}] Set the name of the
files output. Defaults to first class name listed if not set.
\item[\Opt{-no_copy_ctor}] Do not provide a copy constructor in the
output code.
\item[\Opt{-no_assignment_operator}] Do not provide an assignment
operator in the output code.
\item[\Opt{-no_ctor}] Do not provide a default constructor in the
output code.
\item[\Opt{-no_dtor}] Do not provide a destructor in the output code.
\item[\Opt{-public_copy_ctor}] Put the copy constructor in the public
section instead of the private section.
\item[\Opt{-public_assignment_operator}] Put the assignment operator in
the public section instead of the private section.
\item[\Opt{-no_dump_diagnostics}] Do not provide a debugging method.
\item[\Opt{-no_check_valid}] Do not provide a Programming By Contract
style method to check for invariants.
\item[\Opt{-no_icc}] Do not provide a file for class inlines.
\item[\OptArg{-settings_file }{filename}] Get options from a settings
file. Right now this option does nothing.
\section{Requirements}
%%%%%%%%%%%%%%%%%%%%%%
\begin{description}\setlength{\itemsep}{1cm}
\item[Python] \Prog{fcc} requires Python version $>=$ 2.0
\end{description}
\section{Version}
%%%%%%%%%%%%%%%%%
Version: 0.8a of May 5, 2001
\section{License and Copyright}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\begin{description}
\item[Copyright] \copyright\ 2001, Elf M. Sternberg \\
\Email{elf@drizzle.com} \\
\URL{http://www.drizzle.com/~elf}
\item[License] This program can be redistributed and/or modified under the
terms of the GNU Public License. See the file COPYING or visit
\URL{http://www.gnu.org/copyleft/gpl.html} for terms of use and
distribution.
\item[Misc] If you find this software useful, please drop me some email
\item[Misc] This man page was generated using latex2man by Dr. Jurgen
Vollmer, and is available from the CTAN archives.
\end{description}
\section{Author}
%%%%%%%%%%%%%%%%
\noindent
Elf M. Sternberg \\
Email: \Email{elf@drizzle.com} \\
WWW: \URL{http://www.drizzle.com/~elf}.
\LatexManEnd
\end{document}