2010-10-26 00:09:58 +00:00
|
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
|
2011-08-04 21:30:37 +00:00
|
|
|
<!-- Manual page created with latex2man on Thu Aug 4 14:28:15 PDT 2011
|
|
|
|
|
** Author of latex2man: Juergen.Vollmer@informatik-vollmer.de
|
|
|
|
|
** NOTE: This file is generated, DO NOT EDIT. -->
|
2010-10-26 00:09:58 +00:00
|
|
|
<html>
|
2011-08-04 21:30:37 +00:00
|
|
|
<head><title>FCC</title>
|
|
|
|
|
</head><body bgcolor="white">
|
2010-10-26 00:09:58 +00:00
|
|
|
<h1 align=center>
|
|
|
|
|
fcc -<br>
|
|
|
|
|
Fast Class Generator
|
|
|
|
|
</h1>
|
|
|
|
|
<h4 align=center>Elf M. Sternberg </h4>
|
2011-08-04 21:30:37 +00:00
|
|
|
<h4 align=center>04 August 2011</h4>
|
2010-10-26 00:09:58 +00:00
|
|
|
<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>
|
2011-08-04 21:30:37 +00:00
|
|
|
<li><a href="#section_7">Author </a></li>
|
|
|
|
|
</ul>
|
2010-10-26 00:09:58 +00:00
|
|
|
<p>
|
|
|
|
|
<h2><a name="section_1">Synopsis</a></h2>
|
|
|
|
|
|
|
|
|
|
<p>
|
|
|
|
|
<tt>fcc</tt>
|
2011-08-04 21:30:37 +00:00
|
|
|
<font class="optstyle">-class </font><font class="argstyle">list of class names</font>
|
|
|
|
|
<font class="optstyle">-author </font><font class="argstyle">author's name</font>
|
|
|
|
|
[<font class="optstyle">-namespace </font><font class="argstyle">namespace_name</font>]
|
2010-10-26 00:09:58 +00:00
|
|
|
[<b>-overwrite</b>]
|
|
|
|
|
[<b>-verbose</b>]
|
|
|
|
|
[<b>-no_unit_test</b>]
|
|
|
|
|
[<b>-no_makefile</b>]
|
2011-08-04 21:30:37 +00:00
|
|
|
[<font class="optstyle">-project </font><font class="argstyle">project_name</font>]
|
2010-10-26 00:09:58 +00:00
|
|
|
[<b>-sccs_keywords</b>]
|
|
|
|
|
[<b>-continuus_keywords</b>]
|
|
|
|
|
[<b>-open_source_notice</b>]
|
2011-08-04 21:30:37 +00:00
|
|
|
[<font class="optstyle">-copyright </font>[<font class="argstyle">copyright</font>]]
|
|
|
|
|
[<font class="optstyle">-base_filename </font><font class="argstyle">base_filename</font>]
|
2010-10-26 00:09:58 +00:00
|
|
|
[<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>]
|
2011-08-04 21:30:37 +00:00
|
|
|
[<font class="optstyle">-settings_file </font><font class="argstyle">filename</font>]
|
2010-10-26 00:09:58 +00:00
|
|
|
<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>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt><font class="optstyle">-class </font><font class="argstyle">list of class names</font>
|
|
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<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>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt><font class="optstyle">-author </font><font class="argstyle">author's name</font>
|
|
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Your name here.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt><font class="optstyle">-namespace </font><font class="argstyle">namespace name</font>
|
|
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Wrap the output in a
|
|
|
|
|
specified namespace.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-verbose</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Explain in excruciating detail what the program
|
|
|
|
|
is doing.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-no_unit_test</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<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>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Do not generate a makefile for this code.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt><font class="optstyle">-project </font><font class="argstyle">project_name</font>
|
|
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Define a project for this makefile. Right now
|
|
|
|
|
this option does nothing.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-sccs_keywords</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Generate IDs appropriate to SCCS.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-continuus_keywords</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Generate keywords for the Continuus
|
|
|
|
|
Version System.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-open_source_notice</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Add some comments about how this code
|
|
|
|
|
is open source and permission to copy in granted yadda yadda...
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt><font class="optstyle">-copyright </font>[<font class="argstyle">copyright</font>]
|
|
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Adds your copyright notice to the
|
|
|
|
|
code.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt><font class="optstyle">-base_filename </font><font class="argstyle">base_filename</font>
|
|
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<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>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Do not provide a copy constructor in the
|
|
|
|
|
output code.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-no_assignment_operator</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Do not provide an assignment
|
|
|
|
|
operator in the output code.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-no_ctor</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Do not provide a default constructor in the
|
|
|
|
|
output code.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-no_dtor</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Do not provide a destructor in the output code.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-public_copy_ctor</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Put the copy constructor in the public
|
|
|
|
|
section instead of the private section.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-public_assignment_operator</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Put the assignment operator in
|
|
|
|
|
the public section instead of the private section.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-no_dump_diagnostics</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Do not provide a debugging method.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-no_check_valid</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Do not provide a Programming By Contract
|
|
|
|
|
style method to check for invariants.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
|
|
|
|
<dt><b>-no_icc</b>
|
2011-08-04 21:30:37 +00:00
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> Do not provide a file for class inlines.
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt><font class="optstyle">-settings_file </font><font class="argstyle">filename</font>
|
|
|
|
|
</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<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>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt>Python</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> <tt>fcc</tt>
|
|
|
|
|
requires Python version >= 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>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt>Copyright</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> © 2001, Elf M. Sternberg <br>
|
2011-08-04 21:30:37 +00:00
|
|
|
|
|
|
|
|
<a href ="mailto:elf.sternberg@gmail.com"><tt>elf.sternberg@gmail.com</tt></a>
|
|
|
|
|
<br>
|
|
|
|
|
<a href ="http://elfsternberg.com"><tt>http://elfsternberg.com</tt></a>
|
2010-10-26 00:09:58 +00:00
|
|
|
<p>
|
|
|
|
|
</dd>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt>License</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<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>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt>Misc</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<dd> If you find this software useful, please drop me some email
|
|
|
|
|
<p>
|
|
|
|
|
</dd>
|
2011-08-04 21:30:37 +00:00
|
|
|
<dt>Misc</dt>
|
2010-10-26 00:09:58 +00:00
|
|
|
<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>
|
2011-08-04 21:30:37 +00:00
|
|
|
|
|
|
|
|
Email: <a href ="mailto:elf.sternberg@gmail.com"><tt>elf.sternberg@gmail.com</tt></a>
|
|
|
|
|
<br>
|
|
|
|
|
WWW: <a href ="http://elfsternberg.com"><tt>http://elfsternberg.com</tt></a>.
|
2010-10-26 00:09:58 +00:00
|
|
|
</body>
|
|
|
|
|
</html>
|
|
|
|
|
<!-- NOTE: This file is generated, DO NOT EDIT. -->
|
