messages.xsd 0100600 0000764 0000764 00000010207 10111220631 012017 0 ustar iank iank
A class for an aim order. An "aim order" is a market trading objective, perhaps for a stock market order.
* @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ public class AimOrder extends MessageBase { private static class MessageStates extends TypeSafeEnum { public MessageStates(String name) { super(name, AimOrder.MessageStates.class); } public static MessageStates START_MSG = new MessageStates("START_MSG"); public static MessageStates SYMBOL = new MessageStates("SYMBOL"); public static MessageStates AMOUNT = new MessageStates("AMOUNT"); public static MessageStates TARGET_PRICE = new MessageStates("TARGET_PRICE"); public static MessageStates MARKET = new MessageStates("MARKET"); public static MessageStates INSTRUCTIONS = new MessageStates("INSTRUCTIONS"); public static MessageStates END_MSG = new MessageStates("END_MSG"); } // class MessageStates public AimOrder() {} String mSymbol = null; int mAmount = 0; float mTargetPrice = 0.0F; String mMarket = null; String mInstructions = null; private MessageStates mCurrentState = MessageStates.START_MSG; public int getAmount() { return mAmount; } private void setAmount(int amount) { mAmount = amount; } public String getInstructions() { return mInstructions; } private void setInstructions(String instructions) { mInstructions = instructions; } public String getMarket() { return mMarket; } private void setMarket(String market) { mMarket = market; } public String getSymbol() { return mSymbol; } private void setSymbol(String symbol) { mSymbol = symbol; } public float getTargetPrice() { return mTargetPrice; } private void setTargetPrice(float targetPrice) { mTargetPrice = targetPrice; } protected void initialize( XmlPullParser parser ) throws ParseException, XmlPullParserException, IOException { super.initialize( parser ); while (mCurrentState != MessageStates.END_MSG) { int eventType = parser.next(); if (eventType == XmlPullParser.START_TAG) { String localName = parser.getName(); if (localName.equals("symbol")) { mCurrentState = MessageStates.SYMBOL; } else if (localName.equals("amount")) { mCurrentState = MessageStates.AMOUNT; } else if (localName.equals("targetPrice")) { mCurrentState = MessageStates.TARGET_PRICE; } else if (localName.equals("market")) { mCurrentState = MessageStates.MARKET; } else if (localName.equals("processingInstructions")) { mCurrentState = MessageStates.INSTRUCTIONS; } } else if (eventType == XmlPullParser.TEXT) { if (mCurrentState == MessageStates.SYMBOL ) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { setSymbol( text ); } } else if (mCurrentState == MessageStates.AMOUNT ) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { try { int val = Integer.parseInt( text ); setAmount( val ); } catch (NumberFormatException e) { throw new ParseException("NumberFormatException for text = " + text ); } } } else if (mCurrentState == MessageStates.TARGET_PRICE ) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { try { float val = Float.parseFloat( text ); setTargetPrice( val ); } catch (NumberFormatException e) { throw new ParseException("NumberFormatException for text = " + text ); } } } else if (mCurrentState == MessageStates.MARKET ) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { setMarket( text ); } } else if (mCurrentState == MessageStates.INSTRUCTIONS ) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { setInstructions( text ); } } } else if (eventType == XmlPullParser.END_TAG) { String localName = parser.getName(); if (localName.equals("aim_order")) { mCurrentState = MessageStates.END_MSG; } } } // while } public String toString() { ByteArrayOutputStream bos = new ByteArrayOutputStream(); PrintStream ps = new PrintStream( bos ); super.toStream( ps ); ps.println("symbol: " + mSymbol ); ps.println("amount: " + mAmount ); ps.println("target price: " + mTargetPrice ); ps.println("market: " + mMarket ); ps.println("instructions: " + mInstructions ); String str = bos.toString(); return str; } } pullparse/Control.java 0100600 0000764 0000764 00000007350 10113727347 014011 0 ustar iank iank /** \file * * Aug 14, 2004 * * Copyright Ian Kaplan 2004, Bear Products International * * You may use this code for any purpose, without restriction, * including in proprietary code for which you charge a fee. * In using this code you acknowledge that you understand its * function completely and accept all risk in its use. * * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ package pullparse; import java.io.ByteArrayOutputStream; import java.io.IOException; import java.io.PrintStream; import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** * Control * Aug 14, 2004A market control message. For example, cancel an order. Stop processing an aim order, etc...
* * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ public class Control extends MessageBase { private static class MessageStates extends TypeSafeEnum { public MessageStates(String name) { super(name, Control.MessageStates.class); } public static MessageStates START_MSG = new MessageStates("START_MSG"); public static MessageStates AIM_ORDER_ID = new MessageStates("AIM_ORDER_ID"); public static MessageStates OPERATION = new MessageStates("OPERATION"); public static MessageStates END_MSG = new MessageStates("END_MSG"); } // class MessageStates private String mAimOrderID = null; private String mOperation = null; private MessageStates mCurrentState = MessageStates.START_MSG; public String getAimOrderID() { return mAimOrderID; } private void setAimOrderID(String aimOrderID) { mAimOrderID = aimOrderID; } public String getOperation() { return mOperation; } private void setOperation(String operation) { mOperation = operation; } protected void initialize( XmlPullParser parser ) throws ParseException, XmlPullParserException, IOException { super.initialize( parser ); while (mCurrentState != MessageStates.END_MSG) { int eventType = parser.next(); if (eventType == XmlPullParser.START_TAG) { String localName = parser.getName(); if (localName.equals("aimOrderID")) { mCurrentState = MessageStates.AIM_ORDER_ID; } else if (localName.equals("operation")) { mCurrentState = MessageStates.OPERATION; } } else if (eventType == XmlPullParser.TEXT) { if (mCurrentState == MessageStates.AIM_ORDER_ID) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { setAimOrderID( text ); } } else if (mCurrentState == MessageStates.OPERATION) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { setOperation( text ); } } } else if (eventType == XmlPullParser.END_TAG) { String localName = parser.getName(); if (localName.equals("control")) { mCurrentState = MessageStates.END_MSG; } } } // while } // initialize public String toString() { ByteArrayOutputStream bos = new ByteArrayOutputStream(); PrintStream ps = new PrintStream( bos ); super.toStream( ps ); ps.println("aim order ID: " + mAimOrderID ); ps.println("operation: " + mOperation ); String str = bos.toString(); return str; } } pullparse/MessageBase.java 0100600 0000764 0000764 00000011076 10113732522 014537 0 ustar iank iank /** \file * * Aug 11, 2004 * * Copyright Ian Kaplan 2004, Bear Products International * * You may use this code for any purpose, without restriction, * including in proprietary code for which you charge a fee. * In using this code you acknowledge that you understand its * function completely and accept all risk in its use. * * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ package pullparse; import java.io.IOException; import java.io.PrintStream; import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; /** * MessageBase * Aug 11, 2004 *A base class for messages in a market trading system. The "product" might be an computer driven trading program. The user is the identifier for the person who started the product or who is using a manual entry trading system. The local ID is an ID that is meaningful to the trading product.
* @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ public class MessageBase { private static class MessageStates extends TypeSafeEnum { public MessageStates(String name) { super(name, MessageBase.MessageStates.class); } public static MessageStates START_MSG = new MessageStates("START_MSG"); public static MessageStates PRODUCT = new MessageStates("PRODUCT"); public static MessageStates USER = new MessageStates("USER"); public static MessageStates LOCAL_ID = new MessageStates("LOCAL_ID"); public static MessageStates END_MSG = new MessageStates("END_MSG"); } // class MessageStates private String mProduct = null; private String mUser = null; private String mLocalID = null; private MessageStates mCurrentState = MessageStates.START_MSG; public MessageBase() {} public String getLocalID() { return mLocalID; } private void setLocalID(String localID) { mLocalID = localID; } public String getProduct() { return mProduct; } private void setProduct(String product) { mProduct = product; } public String getUser() { return mUser; } private void setUser(String user) { mUser = user; } protected void initialize( XmlPullParser parser ) throws ParseException, XmlPullParserException, IOException { while (mCurrentState != MessageStates.END_MSG) { int eventType = parser.next(); if (eventType == XmlPullParser.START_TAG) { String localName = parser.getName(); if (localName.equals("product")) { mCurrentState = MessageStates.PRODUCT; } else if (localName.equals("user")) { mCurrentState = MessageStates.USER; } else if (localName.equals("localID")) { mCurrentState = MessageStates.LOCAL_ID; } else { String msg = parser.getPositionDescription(); msg = msg + ": Unexpected tag found initializing MessageBase = " + localName; throw new ParseException( msg ); } } else if (eventType == XmlPullParser.TEXT) { if (mCurrentState == MessageStates.PRODUCT) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { setProduct( text ); } } else if (mCurrentState == MessageStates.USER) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { setUser( text ); } } else if (mCurrentState == MessageStates.LOCAL_ID) { String text = parser.getText(); text = text.trim(); if (text.length() > 0) { setLocalID( text ); } } } else if (eventType == XmlPullParser.END_TAG) { String localName = parser.getName(); if (localName.equals("localID")) { mCurrentState = MessageStates.END_MSG; } } } // while } // initialize public void toStream( PrintStream ps ) { ps.println("product: " + mProduct ); ps.println("user: " + mUser ); ps.println("local ID: " + mLocalID ); } } pullparse/ParseException.java 0100600 0000764 0000764 00000001517 10113455344 015314 0 ustar iank iank /** \file * * Aug 26, 2004 * * Copyright Ian Kaplan 2004, Bear Products International * * You may use this code for any purpose, without restriction, * including in proprietary code for which you charge a fee. * In using this code you acknowledge that you understand its * function completely and accept all risk in its use. * * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ package pullparse; /** * ParseException * Aug 26, 2004 * * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ public class ParseException extends Exception { /** * @param message */ public ParseException(String message) { super(message); } /** * @param message * @param cause */ public ParseException(String message, Throwable cause) { super(message, cause); } } pullparse/ParseXML.java 0100600 0000764 0000764 00000005347 10113732415 014020 0 ustar iank iank /** \file * * Aug 24, 2004 * * Copyright Ian Kaplan 2004, Bear Products International * * You may use this code for any purpose, without restriction, * including in proprietary code for which you charge a fee. * In using this code you acknowledge that you understand its * function completely and accept all risk in its use. * * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ package pullparse; import java.io.FileReader; import java.io.IOException; import java.util.ArrayList; import org.xmlpull.v1.XmlPullParser; import org.xmlpull.v1.XmlPullParserException; import org.xmlpull.v1.XmlPullParserFactory; /** * ParseXML * Aug 24, 2004 * * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ public class ParseXML { XmlPullParser mPullParser = null; /** Initialize the mPullParser with an XmpPullParser object. @param validating true = XML Schema validation, false, no validation. At the time of this writing, XmlPullParser does not support validation. */ public ParseXML( boolean validating ) throws XmlPullParserException { XmlPullParserFactory factory; factory = XmlPullParserFactory.newInstance(); factory.setNamespaceAware( true ); factory.setValidating( validating ); mPullParser = factory.newPullParser(); } // constructor /** Parse a trade engine message document. This method reads the start document tag, end document tag and the tags that start each of the trade engine messages. When a message start tag is read, the associated message object is created. The parser is passed to the initialize method of the trade engine message, allowing the object to initialize itself from the XML. */ public void parse( FileReader reader, ArrayList msgList ) throws XmlPullParserException, IOException, ParseException { assert mPullParser != null; mPullParser.setInput( reader ); for (int eventType = mPullParser.getEventType(); eventType != XmlPullParser.END_DOCUMENT; eventType = mPullParser.next()) { if (eventType == XmlPullParser.START_TAG) { String localName = mPullParser.getName(); MessageBase message = null; if (localName.equals("aim_order")) { message = new AimOrder(); } else if (localName.equals("control")) { message = new Control(); } if (message != null) { message.initialize( mPullParser ); msgList.add( message ); } } } // for } // parse } // ParseXML pullparse/TestMain.java 0100600 0000764 0000764 00000012305 10113720534 014100 0 ustar iank iank /** \file * * Aug 14, 2004 * * Copyright Ian Kaplan 2004, Bear Products International * * You may use this code for any purpose, without restriction, * including in proprietary code for which you charge a fee. * In using this code you acknowledge that you understand its * function completely and accept all risk in its use. * * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ package pullparse; import java.io.FileNotFoundException; import java.io.FileReader; import java.io.IOException; import java.util.ArrayList; import org.xmlpull.v1.XmlPullParserException; /** * TestMain * Aug 14, 2004A test driver for SAX Parsing. The main method is passed a file name and an optional flag that defines whether the parser should be validating or not.
* * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ public class TestMain { private void usage() { String name = getClass().getName(); System.out.println("usage: " + name + "validate=false validate=true
If the flag has some other value the method will print a message and return true (since the value for the validate flag is true by default).
*/ private boolean parseValidateFlag( String validateFlag ) { boolean validate = true; boolean flagOK = false; validateFlag = validateFlag.trim(); if (validateFlag.startsWith("validate")) { int eqIx = validateFlag.indexOf("="); if (eqIx > 0) { String boolStr = validateFlag.substring( eqIx + 1 ); boolStr = boolStr.trim(); if (boolStr.equals("true") || boolStr.equals("false")) { flagOK = true; if (boolStr.equals("false")) { validate = false; } } } } if (! flagOK) { String name = getClass().getName(); System.out.println("validate flag usage: \"validate=false\" or \"validate=true\""); } return validate; } // parseValidateFlag /** Print the trade engine messages to standard output. */ private void printList( ArrayList msgList ) { int len = msgList.size(); for (int i = 0; i < len; i++) { Object obj = msgList.get( i ); if (obj instanceof AimOrder) { AimOrder t = (AimOrder)obj; System.out.println("Aim Order:"); System.out.println( t ); } else if (obj instanceof Control) { Control t = (Control)obj; System.out.println("Control:"); System.out.println( t ); } else { System.out.println("Unexpected object in msgList:" + obj.getClass().getName()); } } } // printList private void printXMLPullError( XmlPullParserException e, String xmlFileName ) { int lineNum = e.getLineNumber(); int columnNumber = e.getColumnNumber(); String exceptionMsg = e.getMessage(); String msg = xmlFileName + "(" + lineNum + ", " + columnNumber + "): " + exceptionMsg; System.out.println(msg); } // printXMLPullError /** Use the SAX parser to parse trade engine messages read from a file */ private void test(String[] args) { if (args.length >= 1 && args.length <= 2) { String xmlFileName = null; boolean validate = true; for (int i = 0; i < args.length; i++) { switch (i) { case 0: xmlFileName = args[0]; break; case 1: String validateFlag = args[1]; validate = parseValidateFlag( validateFlag ); break; } // switch; } // for FileReader reader = null; try { reader = new FileReader( xmlFileName ); ParseXML parse = new ParseXML( false ); ArrayList msgList = new ArrayList(); parse.parse( reader, msgList ); printList( msgList ); } catch (FileNotFoundException e) { System.out.println("Error opening file " + xmlFileName + " = " + e); } catch (IOException e1) { System.out.println(xmlFileName + ": IOException = " + e1 ); } catch (XmlPullParserException e2) { printXMLPullError( e2, xmlFileName ); } catch (ParseException e3) { System.out.println( e3 ); } } else { usage(); } } // test public static void main(String[] args) { TestMain t = new TestMain(); t.test( args ); } } pullparse/TypeSafeEnum.java 0100700 0000764 0000764 00000005666 10112464635 014744 0 ustar iank iank /* * Created on Jul 12, 2004 * * Copyright Ian Kaplan 2004, Bear Products International * * You may use this code for any purpose, without restriction, * including in proprietary code for which you charge a fee. * In using this code you acknowledge that you understand its * function completely and accept all risk in its use. * * @author Ian Kaplan, www.bearcave.com, iank@bearcave.com */ package pullparse; /** * TypeSafeEnum * * @author Ian Kaplan, iank@bearcave.com, Jul 12, 2004 * */ import java.util.ArrayList; import java.util.Iterator; /** Yet another type safe enumeration base class. This class supports the creation of multiple enumeration subclasses. In each subclass the enumeration values start at 0.Documentation for this class can be found here. Apparently TypeSafeEnums are supported in the new version of Java. So at some point the classes that use this class should be replaced with something more generic.
*/ public abstract class TypeSafeEnum { private static class enumInfo { public int hashCode; public int count; public ArrayList values; enumInfo( int hash ) { hashCode = hash; count = 0; values = new ArrayList(); } } // class enumInfo private static ArrayList infoVec = new ArrayList(); private String mName; private int mValue; public TypeSafeEnum( String name, Class cls ) { mName = name; enumInfo elem = findInfo( cls, true ); mValue = elem.count; elem.count++; elem.values.add( this ); } // TypeSafeEnum constructor public static Iterator enumValues( Class cls ) { Iterator iter = null; enumInfo elem = findInfo( cls, false ); if (elem != null) { iter = elem.values.iterator(); } return iter; } // enumValues public String getName() { return mName; } public int getValue() { return mValue; } public String toString() { return getName(); } /** Find the entry for the enumeration, if it exists. If not, add it to the end of the enumInfo. Note that this function has linear time, but the assumption is that there will not a large number of enumeration classes. */ private static enumInfo findInfo(Class cls, boolean add) { enumInfo foundElem = null; int hashCode = cls.hashCode(); for (Iterator iter = infoVec.iterator(); iter.hasNext(); ) { enumInfo elem = (enumInfo)iter.next(); if (elem.hashCode == hashCode) { foundElem = elem; break; } } if (foundElem == null && add) { foundElem = new enumInfo(hashCode); infoVec.add( foundElem ); } return foundElem; } // findInfo } pullparse/doxygenPullParse 0100600 0000764 0000764 00000127224 10114110711 014737 0 ustar iank iank # Doxyfile 1.3.3 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project # # All text after a hash (#) is considered a comment and will be ignored # The format is: # TAG = value [value, ...] # For lists items can also be appended using: # TAG += value [value, ...] # Values that contain spaces should be placed between quotes (" ") #--------------------------------------------------------------------------- # General configuration options #--------------------------------------------------------------------------- # The PROJECT_NAME tag is a single word (or a sequence of words surrounded # by quotes) that should identify the project. PROJECT_NAME = PullParse # The PROJECT_NUMBER tag can be used to enter a project or revision number. # This could be handy for archiving the generated documentation or # if some version control system is used. PROJECT_NUMBER = # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. # If a relative path is entered, it will be relative to the location # where doxygen was started. If left blank the current directory will be used. OUTPUT_DIRECTORY = pullparse_doc # The OUTPUT_LANGUAGE tag is used to specify the language in which all # documentation generated by doxygen is written. Doxygen will use this # information to generate all constant output in the proper language. # The default language is English, other supported languages are: # Brazilian, Catalan, Chinese, Chinese-Traditional, Croatian, Czech, Danish, Dutch, # Finnish, French, German, Greek, Hungarian, Italian, Japanese, Japanese-en # (Japanese with English messages), Korean, Norwegian, Polish, Portuguese, # Romanian, Russian, Serbian, Slovak, Slovene, Spanish, Swedish, and Ukrainian. OUTPUT_LANGUAGE = English # This tag can be used to specify the encoding used in the generated output. # The encoding is not always determined by the language that is chosen, # but also whether or not the output is meant for Windows or non-Windows users. # In case there is a difference, setting the USE_WINDOWS_ENCODING tag to YES # forces the Windows encoding (this is the default for the Windows binary), # whereas setting the tag to NO uses a Unix-style encoding (the default for # all platforms other than Windows). USE_WINDOWS_ENCODING = YES # If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in # documentation are documented, even if no documentation was available. # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES all private members of a class # will be included in the documentation. EXTRACT_PRIVATE = YES # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) # defined locally in source files will be included in the documentation. # If set to NO only classes defined in header files are included. EXTRACT_LOCAL_CLASSES = YES # If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all # undocumented members of documented classes, files or namespaces. # If set to NO (the default) these members will be included in the # various overviews, but no documentation section is generated. # This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_MEMBERS = NO # If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all # undocumented classes that are normally visible in the class hierarchy. # If set to NO (the default) these classes will be included in the various # overviews. This option has no effect if EXTRACT_ALL is enabled. HIDE_UNDOC_CLASSES = NO # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all # friend (class|struct|union) declarations. # If set to NO (the default) these declarations will be included in the # documentation. HIDE_FRIEND_COMPOUNDS = NO # If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any # documentation blocks found inside the body of a function. # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. HIDE_IN_BODY_DOCS = NO # If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will # include brief member descriptions after the members that are listed in # the file and class documentation (similar to JavaDoc). # Set to NO to disable this. BRIEF_MEMBER_DESC = YES # If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend # the brief description of a member or function before the detailed description. # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. REPEAT_BRIEF = YES # If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then # Doxygen will generate a detailed section even if there is only a brief # description. ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all inherited # members of a class in the documentation of that class as if those members were # ordinary class members. Constructors, destructors and assignment operators of # the base classes will not be shown. INLINE_INHERITED_MEMB = NO # If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full # path before files name in the file list and in the header files. If set # to NO the shortest path that makes the file name unique will be used. FULL_PATH_NAMES = NO # If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag # can be used to strip a user-defined part of the path. Stripping is # only done if one of the specified strings matches the left-hand part of # the path. It is allowed to use relative paths in the argument list. STRIP_FROM_PATH = # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set # to NO (the default) then the documentation will be excluded. # Set it to YES to include the internal documentation. INTERNAL_DOCS = NO # If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate # file names in lower-case letters. If set to YES upper-case letters are also # allowed. This is useful if you have classes or files whose names only differ # in case and if your file system supports case sensitive file names. Windows # users are advised to set this option to NO. CASE_SENSE_NAMES = YES # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter # (but less readable) file names. This can be useful is your file systems # doesn't support long names like on DOS, Mac, or CD-ROM. SHORT_NAMES = NO # If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen # will show members with their full class and namespace scopes in the # documentation. If set to YES the scope will be hidden. HIDE_SCOPE_NAMES = NO # If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen # will put a list of the files that are included by a file in the documentation # of that file. SHOW_INCLUDE_FILES = YES # If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen # will interpret the first line (until the first dot) of a JavaDoc-style # comment as the brief description. If set to NO, the JavaDoc # comments will behave just like the Qt-style comments (thus requiring an # explict @brief command for a brief description. JAVADOC_AUTOBRIEF = YES # The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen # treat a multi-line C++ special comment block (i.e. a block of //! or /// # comments) as a brief description. This used to be the default behaviour. # The new default is to treat a multi-line C++ comment block as a detailed # description. Set this tag to YES if you prefer the old behaviour instead. MULTILINE_CPP_IS_BRIEF = NO # If the DETAILS_AT_TOP tag is set to YES then Doxygen # will output the detailed description near the top, like JavaDoc. # If set to NO, the detailed description appears after the member # documentation. DETAILS_AT_TOP = YES # If the INHERIT_DOCS tag is set to YES (the default) then an undocumented # member inherits the documentation from any documented member that it # reimplements. INHERIT_DOCS = YES # If the INLINE_INFO tag is set to YES (the default) then a tag [inline] # is inserted in the documentation for inline members. INLINE_INFO = YES # If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen # will sort the (detailed) documentation of file and class members # alphabetically by member name. If set to NO the members will appear in # declaration order. SORT_MEMBER_DOCS = YES # If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC # tag is set to YES, then doxygen will reuse the documentation of the first # member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. DISTRIBUTE_GROUP_DOC = NO # The TAB_SIZE tag can be used to set the number of spaces in a tab. # Doxygen uses this value to replace tabs by spaces in code fragments. TAB_SIZE = 8 # The GENERATE_TODOLIST tag can be used to enable (YES) or # disable (NO) the todo list. This list is created by putting \todo # commands in the documentation. GENERATE_TODOLIST = YES # The GENERATE_TESTLIST tag can be used to enable (YES) or # disable (NO) the test list. This list is created by putting \test # commands in the documentation. GENERATE_TESTLIST = YES # The GENERATE_BUGLIST tag can be used to enable (YES) or # disable (NO) the bug list. This list is created by putting \bug # commands in the documentation. GENERATE_BUGLIST = YES # The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or # disable (NO) the deprecated list. This list is created by putting # \deprecated commands in the documentation. GENERATE_DEPRECATEDLIST= YES # This tag can be used to specify a number of aliases that acts # as commands in the documentation. An alias has the form "name=value". # For example adding "sideeffect=\par Side Effects:\n" will allow you to # put the command \sideeffect (or @sideeffect) in the documentation, which # will result in a user-defined paragraph with heading "Side Effects:". # You can put \n's in the value part of an alias to insert newlines. ALIASES = # The ENABLED_SECTIONS tag can be used to enable conditional # documentation sections, marked by \if sectionname ... \endif. ENABLED_SECTIONS = # The MAX_INITIALIZER_LINES tag determines the maximum number of lines # the initial value of a variable or define consists of for it to appear in # the documentation. If the initializer consists of more lines than specified # here it will be hidden. Use a value of 0 to hide initializers completely. # The appearance of the initializer of individual variables and defines in the # documentation can be controlled using \showinitializer or \hideinitializer # command in the documentation regardless of this setting. MAX_INITIALIZER_LINES = 30 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources # only. Doxygen will then generate output that is more tailored for C. # For instance, some of the names that are used will be different. The list # of all members will be omitted, etc. OPTIMIZE_OUTPUT_FOR_C = NO # Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java sources # only. Doxygen will then generate output that is more tailored for Java. # For instance, namespaces will be presented as packages, qualified scopes # will look different, etc. OPTIMIZE_OUTPUT_JAVA = YES # Set the SHOW_USED_FILES tag to NO to disable the list of files generated # at the bottom of the documentation of classes and structs. If set to YES the # list will mention the files that were used to generate the documentation. SHOW_USED_FILES = YES # Set the SUBGROUPING tag to YES (the default) to allow class member groups of # the same type (for instance a group of public functions) to be put as a # subgroup of that type (e.g. under the Public Functions section). Set it to # NO to prevent subgrouping. Alternatively, this can be done per class using # the \nosubgrouping command. SUBGROUPING = YES #--------------------------------------------------------------------------- # configuration options related to warning and progress messages #--------------------------------------------------------------------------- # The QUIET tag can be used to turn on/off the messages that are generated # by doxygen. Possible values are YES and NO. If left blank NO is used. QUIET = NO # The WARNINGS tag can be used to turn on/off the warning messages that are # generated by doxygen. Possible values are YES and NO. If left blank # NO is used. WARNINGS = YES # If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some # parameters in a documented function, or documenting parameters that # don't exist or using markup commands wrongly. WARN_IF_DOC_ERROR = YES # The WARN_FORMAT tag determines the format of the warning messages that # doxygen can produce. The string should contain the $file, $line, and $text # tags, which will be replaced by the file and line number from which the # warning originated and the warning text. WARN_FORMAT = "$file:$line: $text" # The WARN_LOGFILE tag can be used to specify a file to which warning # and error messages should be written. If left blank the output is written # to stderr. WARN_LOGFILE = #--------------------------------------------------------------------------- # configuration options related to the input files #--------------------------------------------------------------------------- # The INPUT tag can be used to specify the files and/or directories that contain # documented source files. You may enter file names like "myfile.cpp" or # directories like "/usr/src/myproject". Separate the files or directories # with spaces. INPUT = # If the value of the INPUT tag contains directories, you can use the # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank the following patterns are tested: # *.c *.cc *.cxx *.cpp *.c++ *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp # *.h++ *.idl *.odl *.cs FILE_PATTERNS = AimOrder.java Control.java MessageBase.java ParseException.java ParseXML.java TestMain.java TypeSafeEnum.java # The RECURSIVE tag can be used to turn specify whether or not subdirectories # should be searched for input files as well. Possible values are YES and NO. # If left blank NO is used. RECURSIVE = NO # The EXCLUDE tag can be used to specify files and/or directories that should # excluded from the INPUT source files. This way you can easily exclude a # subdirectory from a directory tree whose root is specified with the INPUT tag. EXCLUDE = # The EXCLUDE_SYMLINKS tag can be used select whether or not files or directories # that are symbolic links (a Unix filesystem feature) are excluded from the input. EXCLUDE_SYMLINKS = NO # If the value of the INPUT tag contains directories, you can use the # EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude # certain files from those directories. EXCLUDE_PATTERNS = # The EXAMPLE_PATH tag can be used to specify one or more files or # directories that contain example code fragments that are included (see # the \include command). EXAMPLE_PATH = # If the value of the EXAMPLE_PATH tag contains directories, you can use the # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp # and *.h) to filter out the source-files in the directories. If left # blank all files are included. EXAMPLE_PATTERNS = # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be # searched for input files to be used with the \include or \dontinclude # commands irrespective of the value of the RECURSIVE tag. # Possible values are YES and NO. If left blank NO is used. EXAMPLE_RECURSIVE = NO # The IMAGE_PATH tag can be used to specify one or more files or # directories that contain image that are included in the documentation (see # the \image command). IMAGE_PATH = # The INPUT_FILTER tag can be used to specify a program that doxygen should # invoke to filter for each input file. Doxygen will invoke the filter program # by executing (via popen()) the command