From 7f089045bce33cf309f807d1cee97a8beb7bb859 Mon Sep 17 00:00:00 2001 From: Boris Kolpackov Date: Wed, 28 Oct 2009 14:21:38 +0200 Subject: Documentation fixes --- doc/cli.1 | 4 +- doc/cli.xhtml | 4 +- doc/guide/guide.html2ps | 2 +- doc/guide/index.xhtml | 134 ++++++++++++++++++++++++------------------------ 4 files changed, 72 insertions(+), 72 deletions(-) (limited to 'doc') diff --git a/doc/cli.1 b/doc/cli.1 index 0470199..80e3bc6 100644 --- a/doc/cli.1 +++ b/doc/cli.1 @@ -22,7 +22,7 @@ cli \- command line interface compiler for C++ .SH DESCRIPTION .\"-------------------------------------------------------------------- .B cli -generates C++ implementation for command line interface defined in the CLI +generates a C++ implementation for a command line interface defined in the CLI language. For an input file in the form .B name.cli the following C++ files are generated: @@ -90,7 +90,7 @@ Use the provided .I separator instead of the default .B -- -as an optional separator between options and arguments. All command line +as an optional separator between options and arguments. All the command line arguments that are parsed after this separator are treated as program arguments. Set the option separator to the empty value if you don't want this functionality. diff --git a/doc/cli.xhtml b/doc/cli.xhtml index 6ac5d6a..b026b6e 100644 --- a/doc/cli.xhtml +++ b/doc/cli.xhtml @@ -59,7 +59,7 @@

DESCRIPTION

-

cli generates C++ implementation for command +

cli generates a C++ implementation for a command line interface defined in the CLI language. For an input file in the form name.cli the following C++ files are generated: name.hxx (header file), name.ixx @@ -109,7 +109,7 @@

--option-separator separator
Use the provided separator instead of the default -- as an optional separator between options and - arguments. All command line arguments that are parsed after this + arguments. All the command line arguments that are parsed after this separator are treated as program arguments. Set the option separator to the empty value if you don't want this functionality.
diff --git a/doc/guide/guide.html2ps b/doc/guide/guide.html2ps index 74005f7..f5f2a09 100644 --- a/doc/guide/guide.html2ps +++ b/doc/guide/guide.html2ps @@ -22,7 +22,7 @@

Copyright © 2009 Code Synthesis Tools CC

-

Permission is granted to copy, distribute and/or modify this document +

Permission is granted to copy, distribute, and/or modify this document under the terms of the MIT License.

diff --git a/doc/guide/index.xhtml b/doc/guide/index.xhtml index b021cbf..f565eaa 100644 --- a/doc/guide/index.xhtml +++ b/doc/guide/index.xhtml @@ -142,7 +142,7 @@

Copyright © 2009 Code Synthesis Tools CC

-

Permission is granted to copy, distribute and/or modify this document +

Permission is granted to copy, distribute, and/or modify this document under the terms of the MIT License.

@@ -190,11 +190,11 @@

1 Introduction

Command Line Interface (CLI) definition language is a domain-specific - language (DSL) that was designed for specifying command line interfaces - of C++ programs. CLI defintions are translated to C++ classes using the - CLI compiler. These classes implement parsing of the command line - arguments and provide a convenient interface for accessing the - extracted data.

+ language (DSL) for defining command line interfaces of C++ programs. + CLI definitions are automatically translated to C++ classes using the + CLI compiler. These classes implement parsing of the command + line arguments and provide a convenient and type-safe interface + for accessing the extracted data.

Beyond this guide, you may also find the following sources of information useful:

@@ -225,7 +225,7 @@

In this chapter we will examine how to define a very simple command line interface in CLI, translate this interface to C++, and use the - result in our application. The code presented in this chapter is based + result in an application. The code presented in this chapter is based on the hello example which can be found in the examples/hello/ directory of the CLI distribution.

@@ -233,18 +233,18 @@

Our hello application is going to print a greeting line for each name supplied on the command line. It will also - support a number of command line options that can be used to - customize the greeting line. These options are: --greeting - and --exclamations. The --greeting - option allows us to specify the greeting pharse instead of the + support two command line options, --greeting + and --exclamations, that can be used to + customize the greeting line. The --greeting + option allows us to specify the greeting phrase instead of the default "Hello". The --exclamations - option is used to specify how many exclamations marks should - be prined at the end of each greeting. We will also support + option is used to specify how many exclamation marks should + be printed at the end of each greeting. We will also support the --help option which triggers printing of the usage information.

-

Now we can write a description of the above command line interface - in the CLI language and save it into hello.cli:

+

We can now write a description of the above command line interface + in the CLI language and save it into hello.cli:

 include <string>;
@@ -261,12 +261,12 @@ class options
      clear (the CLI language is covered in greater detail in the next
      chapter), it should be easy to connect declarations in
      hello.cli to the command line interface described in
-     the preceeding paragrpahs. The next step is to translate this
+     the preceding paragraphs. The next step is to translate this
      interface specification to C++.

 
-  
2.2 Translating CLI Defintions to C++

+  
2.2 Translating CLI Definitions to C++

 
-  
Now we are ready to translate our hello.cli to C++.
+  
Now we are ready to translate hello.cli to C++.
      To do this we invoke the CLI compiler from a terminal (UNIX) or
      a command prompt (Windows):
   

@@ -277,8 +277,8 @@ $ cli hello.cli
 
   
This invocation of the CLI compiler produces three C++ files:
      hello.hxx hello.ixx, and
-     hello.cxx. You can change the extensions in these
-     files with the compiler command line options. See the
+     hello.cxx. You can change the file name extensions
+     for these files with the compiler command line options. See the
      CLI
      Compiler Command Line Manual for more information.

 
@@ -315,12 +315,12 @@ private:
      CLI class. For each option in this CLI class an accessor function is
      generated inside the C++ class. The options C++ class also
      defines a number of overloaded constructs that we can use to parse the
-     argc/argv array. Let's now see how we can use this genearted
+     argc/argv array. Let's now see how we can use this generated
      class to implement option parsing in our hello application.

 
   
2.3 Implementing Application Logic

 
-  
At this point we have all the parts we need to implement our
+  
At this point we have everything we need to implement our
      application:

 
   
@@ -382,11 +382,11 @@ main (int argc, char* argv[])
 
   
At the beginning of our application we create the options
      object which parses the command line. The end variable
-     contains the index of the first non-option argument. Then we access
+     contains the index of the first non-option argument. We then access
      the option values as needed during the application execution. We also
-     catch and print the cli::exception exception in case
-     something goes wrong (for example, an unknown option is specified
-     or an option value is invalid).
+     catch and print cli::exception in case something goes
+     wrong, for example, an unknown option is specified or an option value
+     is invalid.
   

 
   
2.4 Compiling and Running

@@ -431,16 +431,16 @@ usage: driver <options> <names>
   
3 CLI Language

 
   
This chapter describes the CLI language and its mapping to C++.
-     A CLI definition unit consists of zero or more Include
-     Directives followed by one or more Namespace Definition
-     or Option Class Definition. C and C++-style comments
-     can be used anywhere in the CLI definition unit except in character and
+     A CLI file consists of zero or more Include
+     Directives followed by one or more Namespace Definitions
+     or Option Class Definitions. C and C++-style comments
+     can be used anywhere in the CLI file except in character and
      string literals.

 
   
3.1 Option Class Definition

 
 
The central part of the CLI language is option class. An
-   option class contains one or more option definition, for
+   option class contains one or more option definitions, for
    example:

 
   
@@ -498,18 +498,18 @@ public:
 
 
   
An option class is mapped to a C++ class with the same name. The
-     C++ class defines a set of public overloaded constructors, public
-     copy constructor and assignment operator, as well as a set of public
+     C++ class defines a set of public overloaded constructors, a public
+     copy constructor and an assignment operator, as well as a set of public
      accessor functions corresponding to option definitions.

 
   
The argc/argv arguments in the overloaded constructors
      are used to pass the command line arguments array, normally as passed
-     to mail(). The start argument is used to
+     to main(). The start argument is used to
      specify the position in the arguments array from which the parsing
-     should start. Constructor that don't have this argument start from
-     position 1, skipping the executable name in argv[0].
+     should start. The constructors that don't have this argument, start
+     from position 1, skipping the executable name in argv[0].
      The end argument is used to return the position in
-     the arguments array where parsing of options stopped. This is the
+     the arguments array where the parsing of options stopped. This is the
      position of the first program argument, if any.

 
   
The opt_mode and arg_mode arguments
@@ -540,10 +540,10 @@ namespace cli
   
If the mode is skip, the parser skips an unknown
      option or argument and continue parsing. If the mode is
      stop, the parser stops the parsing process. The
-     position of the unknown entitiy is stored in the end
+     position of the unknown entity is stored in the end
      argument. If the mode is fail, the parser throws the
      cli::unknown_option or cli::unknown_argument
-     exception (described blow) on encounertin an unknown option or argument,
+     exception (described blow) on encountering an unknown option or argument,
      respectively.

 
   
The parsing constructor (those with the argc/argv arguments)
@@ -554,11 +554,11 @@ namespace cli
      described above. The missing_value exception is thrown when
      an option value is missing. The invalid_value exception is
      thrown when an option value is invalid, for example, a non-integer value
-     is speicified for an option of type int.

+     is specified for an option of type int.

 
   
All CLI exceptions are derived from the common cli::exception
-     class which provides a polymorphic std::ostream insertion
-     support. For example, you can catch the cli::unknown_option
+     class which implements the polymorphic std::ostream insertion.
+     For example, if you catch the cli::unknown_option
      exception as cli::exception and print it to
      std::cerr, you will get the error message corresponding
      to the unknown_option exception.

@@ -655,21 +655,21 @@ namespace cli
   
3.2 Option Definition

 
 
An option definition consists of there components: type,
-   name, and default value. Option type can be any
-   C++ type as long as its string representation can be extracted using
+   name, and default value. An option type can be any
+   C++ type as long as its string representation can be parsed using
    the std::istream interface. If the option type is
-   user-define then you will need to include its declaration using
+   user-defined then you will need to include its declaration using
    the Include Directive.

 
-
An option of any type other that bool is expected to
+
An option of a type other than bool is expected to
    have a value. An option of type bool is treated as
    a flag and does not have a value. That is, a mere presence of such
-   an option on the command line sets this option value to
+   an option on the command line sets this option's value to
    true.

 
 
The name component specifies the option name as it will be entered
-   in the command line. A name can contain any number of aliases seperated
-   by |. The C++ acessor function name is derived from the
+   in the command line. A name can contain any number of aliases separated
+   by |. The C++ accessor function name is derived from the
    first name by removing any leading special characters, such as
    -, /, etc., and replacing special characters
    in other places with underscore. For example, the following option
@@ -693,7 +693,7 @@ class options
   

 
   
While any option alias can be used on the command line to specify
-     this option value.

+     this option's value.

 
   
If the option name conflicts with one of the CLI language keywords,
      it can be specified as a string literal:

@@ -706,7 +706,7 @@ class options
   

 
   
The final component of the option definition is the optional default
-     value. If the default value is not specified then the option is
+     value. If the default value is not specified, then the option is
      initialized with the default constructor. In particular, this means
      that a bool option will be initialized to false,
      an int option will be initialized to 0, etc.

@@ -732,8 +732,8 @@ class options
 
   
The assignment initialization supports character, string, boolean, and
      simple integer literals (including negative integers) as well
-     as identifiers. For more complex expression use the constructor
-     initialization or wrap the expression in parenthesis, for example:

+     as identifiers. For more complex expressions use the constructor
+     initialization or wrap the expressions in parenthesis, for example:

 
   
 include "constants.hxx"; // Defines default_value.
@@ -746,17 +746,17 @@ class options
 };
   

 
-  
By default when an option is specified two or more times on the command
+  
By default, when an option is specified two or more times on the command
      line, the last value overrides all the previous ones. However, a number
      of standard C++ containers are handled differently to allow collecting
      multiple option values or building key-value maps. These
-     containers are std::vector, std::set and
+     containers are std::vector, std::set, and
      std::map.

 
   
When std::vector or std::set is specified
-     as an option type, all values for this option are inserted into the
+     as an option type, all the values for this option are inserted into the
      container in the order they are encountered. As a result,
-     std::vector will conatin all the values, inclduing
+     std::vector will contain all the values, including
      duplicates while std::set will contain all the unique
      values. For example:

 
@@ -801,21 +801,21 @@ class options
 
   
If you are using user-defined types in your option definitions,
      you will need to include their declarations with the include
-     directive. Include directives can specify < > or
+     directive. Include directives can use < > or
      " "-enclosed paths. The CLI compiler does not
-     actully open or read these files. Instead the include directives
-     are translated to C++ preprocessor #include directive
+     actually open or read these files. Instead, the include directives
+     are translated to C++ preprocessor #include directives
      in the generated C++ header file. For example, the following CLI
      definition:

 
   
 include <string>;
-include "types.hxx"; // Defines the name class.
+include "types.hxx"; // Defines the name_type class.
 
 class options
 {
   std::string --string;
-  name --name;
+  name_type --name;
 };
   

 
@@ -832,7 +832,7 @@ class options
   const std::string&
   string () const;
 
-  const name&
+  const name_type&
   name () const;
 
   ...
@@ -840,8 +840,8 @@ class options

Without the #include directives the std::string - and name type in the options class would be - undeclared and result in compillation errors.

+ and name_type types in the options class would + be undeclared and result in compilation errors.

3.4 Namespace Definition

@@ -877,8 +877,8 @@ namespace compiler } -

The above CLI namespace strcture would result in the equivalent C++ - namespaces strcture:

+

The above CLI namespace structure would result in the equivalent C++ + namespaces structure:

 namespace compiler
-- 
cgit v1.1