Cobalt Framework: Main Page

Introduction

Cobalt Framework supports the implementation of console application. It has following functions:

Command line parser and intermediate representation for the result

Copyright

This software is destributed under GNU Lesser General Public License v2.

Target System

The software is written by ANSI-C. So the porting this framework for the other UNIX system is NOT difficult.

OS: Mac OS X
IDE: Xcode
Lang: ANSI-C

Required Software

Coconut Framework

SCM Repository

See Git repository.

Command Line Parser

Specification

app-name [command] [options] [arguments]

command

The command is optional. You can define one or more commands for the application. Each command can have different options and parameters.

long name option

There are two kind of options. One is long name option, the other is short name option. The prefix of long name option is '--' (ex. '--help'). This is an example of long name option with a parameter.

 --file file_name

short name option

The prefix of short name option is '-' (ex. '-h'). You can define multiple options after the prefix. This is an example of short name option.

 -ch # option 'c' and 'h'

But you can not describe multiple options if it has one or more arguments. For example, when the 'f' option has a paramter, the 'c' is recognized as a parameter, not 'c' option.

 -fc # equals to "-f c"

Implementation

Parser

CBParseCommandLine() function in CBCommandLineParser.h : Parser for command line parameter

Intermediate Representation

CBCommandLine (CBCommandLine.h) : Present entire command line
CBOption (CBOption.h) : Command line option

Command Line Syntax

CBCommandLineForm (CBCommandLineForm.h) : Define the syntax rule for CBCommandLine
CBCommandForm (CBCommandForm.h) : Syntax for the command in the command line
CBOptionForm (CBOptionForm.h) : Syntax for the option in the command line

Error Message

CBError (CBError.h) : The error information returned by the command line parser (See CBCommandLineParser.h)