Package Module

Author	Julien Burdy &Vincent Decorges
Date	17.6.02
Description	AdaDoc root module (class)
File name	module.ads

Clauses

Quick access : Clauses - Generics - Definitions - Subprograms

Context clauses
Dict_TDA

Use clauses
Dict_TDA

Definitions

Quick access : Clauses - Generics - Definitions - Subprograms

Types
*Name*	*Declaration*
Object	abstract tagged private
Object_Access	access Object'Class
Element_Type	(Is_BasicObjects, Is_Choice, Is_Clause, Is_Clauses, Is_Components, Is_ContextClauses, Is_Definitions, Is_Discriminants, Is_Entries, Is_Entry, Is_Exception, Is_Exceptions, Is_Function, Is_GenericInstanciation, Is_GenericInstanciations, Is_GenericParameters, Is_Object, Is_Objects, Is_Package, Is_PackageOrSubprogram, Is_PackagesSubprograms, Is_Parameter, Is_Parameters, Is_Pragma, Is_Pragmas, Is_Rename, Is_Renames, Is_Private, Is_Procedure, Is_ProtectedObject, Is_ProtectedObjects, Is_ProtectedPrivate, Is_Record, Is_Records, Is_SubpGenericParameters, Is_Subprograms, Is_Task, Is_TaskPrivate, Is_Tasks, Is_TypeDef, Is_Types, Is_UseClauses, Is_UseTypeClauses, Is_RepClauses, Is_VariantPart)
Name of elements expected in the XML file. Exemple : Use for know when an element start.

Subprograms

Quick access : Clauses - Generics - Definitions - Subprograms

Initialize	procedure
Purpose : Initialize the module with options. Self : Object itself. Options : The options string for the module.

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in out
Options	String	in

Option_Exist	function
*Return*	Boolean
Purpose : Return true if Option has be entered by the user. Self : Object itself. Option : The option to consult (ex: "c") return : True if the option exist

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Option	String	in

Begin_Document	procedure
Purpose : Receive notification of the beginning of a document. This callback will be called only once. Self : Object itself. Package_Name : The name of the package Atts : The attributs dictionary of the XML current element. Tags : The attributs user defined tags.

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Package_Name	String	in
Tags	Dict_Type	in
Atts	Dict_Type	in

End_Document	procedure
Purpose : Receive notification of the end of a document. This callback will be called only once. Self : Object itself.

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in

Start_Group	procedure
Purpose : Receive notification of the beginning of a group of elements. Self : Object itself. Group : the beginning group.

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Group	Element_Type	in

End_Element	procedure
Purpose : Receive notification of the end of each elements (Element_Type). Self : Object itself. Element : the ending element

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Element	Element_Type	in

A_Choice	procedure
Purpose : Receive notification of each variant part choice. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Value : value of the choice

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Value	String	in

A_Clause	procedure
Purpose : Receive notification of each clause. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Value : value of the clause

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Value	String	in

An_Exception	procedure
Purpose : Receive notification of each exception. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the exception name

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in

A_Pragma	procedure
Purpose : Receive notification of each pragma. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the pragma name

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in

A_Function	procedure
Purpose : Receive notification of each function. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the function name Its_Return_Type : the return type of the function In_Prot_Obj : true if the function is in a protected object

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Return_Type	String	in
Its_Name	String	in
In_Prot_Obj	Boolean	in

A_Generic_Instance	procedure
Purpose : Receive notification of each generic instance. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the generic instance name

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in

A_Package_Subprogram_Gen	procedure
Purpose : Receive notification of each generic package or subprogram. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the package or subprogram name

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in

A_Parameter	procedure
Purpose : Receive notification of each parameter (procedure, function, entry). Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the parameter name Its_Type : the parameter type Its_Mode : the parameter mode (in, out, in out, access)

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Mode	String	in
Its_Type	String	in
Its_Name	String	in

A_Procedure	procedure
Purpose : Receive notification of each procedure. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the procedure name In_Prot_Obj : true if the function is in a protected object

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in
In_Prot_Obj	Boolean	in

A_Protected_Object	procedure
Purpose : Receive notification of each protected type. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the protected object name

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in

A_Record	procedure
Purpose : Receive notification of each record. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the record name

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in

A_Rename	procedure
Purpose : Receive notification of each rename. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the rename name

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in

A_Task	procedure
Purpose : Receive notification of each task. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the task name

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in

A_Type_Definition	procedure
Purpose : Receive notification of each type definition. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the type name Its_Def : the type definition

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Def	String	in
Its_Name	String	in

A_Variant_Part	procedure
Purpose : Receive notification of each variant part. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Discriminant : the discriminant of this choice

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Discriminant	String	in

An_Entry	procedure
Purpose : Receive notification of each entry. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the entry name

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Name	String	in

An_Object	procedure
Purpose : Receive notification of each object. Self : Object itself. Atts : The attributs dictionary of the XML current element. Its_Name : the object name Its_Type : the object type Is_Component : true if this object is in a component

*Parameter name*	*Type*	*Mode*	*Default*
Self	Object	in
Atts	Dict_Type	in
Its_Type	String	in
Its_Name	String	in
Is_Component	Boolean	in