umbrello/umbrello
#include <codedocument.h>
Public Member Functions | |
CodeDocument () | |
virtual | ~CodeDocument () |
QString | cleanName (const QString &name) |
TextBlock * | findTextBlockByTag (const QString &tag, bool descendIntoChildren=false) |
QString | getFileExtension () const |
QString | getFileName () const |
CodeComment * | getHeader () |
QString | getPackage () const |
virtual QString | getPath () |
virtual QString | getUniqueTag (const QString &prefix=QString("")) |
bool | getWriteOutCode () |
QString | ID () const |
bool | insertTextBlock (TextBlock *newBlock, TextBlock *existingBlock, bool after=true) |
virtual void | loadFromXMI (QDomElement &root) |
virtual CodeBlock * | newCodeBlock () |
virtual CodeBlockWithComments * | newCodeBlockWithComments () |
virtual HierarchicalCodeBlock * | newHierarchicalCodeBlock () |
virtual void | saveToXMI (QDomDocument &doc, QDomElement &root) |
void | setFileExtension (const QString &new_var) |
void | setFileName (const QString &new_var) |
void | setHeader (CodeComment *comment) |
void | setID (const QString &new_id) |
void | setPackage (UMLPackage *new_var) |
void | setWriteOutCode (bool new_var) |
virtual void | synchronize () |
virtual QString | toString () |
virtual void | updateContent () |
Public Member Functions inherited from CodeGenObjectWithTextBlocks | |
CodeGenObjectWithTextBlocks (CodeDocument *parent) | |
virtual | ~CodeGenObjectWithTextBlocks () |
CodeBlockWithComments * | addOrUpdateTaggedCodeBlockWithComments (const QString &tag, const QString &text, const QString &ctext, int indentLevel, bool forceUserBlockUpdate) |
CodeComment * | addOrUpdateTaggedCodeComment (const QString &tag="", const QString &text="", int indentationLevel=0) |
virtual bool | addTextBlock (TextBlock *add_object) |
CodeGenObjectWithTextBlocks * | findParentObjectForTaggedTextBlock (const QString &tag) |
TextBlock * | findTextBlockByTag (const QString &tag) |
virtual CodeBlockWithComments * | getCodeBlockWithComments (const QString &tag, const QString &comment, int indentLevel) |
virtual HierarchicalCodeBlock * | getHierarchicalCodeBlock (const QString &tag, const QString &comment, int indentLevel) |
TextBlockList * | getTextBlockList () const |
virtual bool | removeTextBlock (TextBlock *remove_object) |
Protected Member Functions | |
void | addChildTagToMap (const QString &tag, TextBlock *tb) |
virtual TextBlock * | findCodeClassFieldTextBlockByTag (const QString &tag) |
void | removeChildTagFromMap (const QString &tag) |
void | resetTextBlocks () |
virtual void | setAttributesFromNode (QDomElement &element) |
virtual void | setAttributesOnNode (QDomDocument &doc, QDomElement &blockElement) |
void | updateHeader () |
Protected Member Functions inherited from CodeGenObjectWithTextBlocks | |
virtual void | loadChildTextBlocksFromNode (QDomElement &root) |
void | setAttributesFromObject (CodeGenObjectWithTextBlocks *obj) |
Friends | |
QDebug | operator<< (QDebug os, const CodeDocument &obj) |
Additional Inherited Members | |
Protected Attributes inherited from CodeGenObjectWithTextBlocks | |
QMap< QString, TextBlock * > | m_textBlockTagMap |
TextBlockList | m_textblockVector |
Detailed Description
A document containing the code for one file.
"friend" status is needed for HBlock so it may call addChildTagToMap which is protected.
Definition at line 32 of file codedocument.h.
Constructor & Destructor Documentation
CodeDocument::CodeDocument | ( | ) |
Constructor.
Definition at line 29 of file codedocument.cpp.
|
virtual |
Destructor.
Definition at line 40 of file codedocument.cpp.
Member Function Documentation
|
protected |
Definition at line 486 of file codedocument.cpp.
QString CodeDocument::cleanName | ( | const QString & | name | ) |
A little utility method which calls CodeGenerator::cleanName.
- Parameters
-
name the cleanable name
- Returns
- the cleaned name
Definition at line 269 of file codedocument.cpp.
|
protectedvirtual |
Have to implement this for CodeObjectWithTextBlocks.
Actually does not do anythying for a vannilla code document.
Implements CodeGenObjectWithTextBlocks.
Reimplemented in ClassifierCodeDocument.
Definition at line 516 of file codedocument.cpp.
TextBlock * CodeDocument::findTextBlockByTag | ( | const QString & | tag, |
bool | descendIntoChildren = false |
||
) |
Lookup a certain textblock by its tag value, returns NULL if it can not find the TextBlock with such a tag.
If descendIntoChildren is true, then any child hierarchical textblocks will also be searched for a match.
- Parameters
-
tag the tag to look for descendIntoChildren look down the hierarchy
- Returns
- the found text block
Definition at line 499 of file codedocument.cpp.
QString CodeDocument::getFileExtension | ( | ) | const |
Get the value of m_fileExtension.
- Returns
- the value of m_fileExtension
Definition at line 82 of file codedocument.cpp.
QString CodeDocument::getFileName | ( | ) | const |
Get the value of m_filename.
This name is the "complete" filename, meaning that it contains both the file name plus any extension (e.g. "file.cpp").
- Returns
- the value of m_filename
Definition at line 63 of file codedocument.cpp.
CodeComment * CodeDocument::getHeader | ( | ) |
Get the Header comment object.
- Returns
- the comment for the header
Definition at line 182 of file codedocument.cpp.
QString CodeDocument::getPackage | ( | ) | const |
Get the value of the package of this code document.
- Returns
- the value of m_pathName
Definition at line 122 of file codedocument.cpp.
|
virtual |
Get the value of the path to this code document.
- Returns
- the value of m_pathName
Reimplemented in JavaClassifierCodeDocument, DClassifierCodeDocument, RubyClassifierCodeDocument, CPPMakefileCodeDocument, and JavaANTCodeDocument.
Definition at line 100 of file codedocument.cpp.
|
virtual |
Return a unique and currently unallocated text block tag for this document.
- Parameters
-
prefix the prefix to add
- Returns
- the just created unique tag
Implements CodeGenObjectWithTextBlocks.
Definition at line 192 of file codedocument.cpp.
bool CodeDocument::getWriteOutCode | ( | ) |
Get the value of m_writeOutCode.
Whether or not to write out this code document and any codeblocks, etc that it owns.
- Returns
- the value of m_writeOutCode
Definition at line 164 of file codedocument.cpp.
QString CodeDocument::ID | ( | ) | const |
|
virtual |
Insert a new text block after the existing text block.
Returns false if it cannot insert the textblock.
- Parameters
-
newBlock the text block to insert existingBlock the place where to insert after at the index of the existingBlock or after
- Returns
- the success status
Implements CodeGenObjectWithTextBlocks.
Definition at line 215 of file codedocument.cpp.
|
virtual |
Load params from the appropriate XMI element node.
- Parameters
-
root the starting point for loading
Reimplemented in ClassifierCodeDocument, and JavaANTCodeDocument.
Definition at line 347 of file codedocument.cpp.
|
virtual |
Create a new CodeBlock object belonging to this CodeDocument.
- Returns
- the just created CodeBlock
Implements CodeGenObjectWithTextBlocks.
Definition at line 456 of file codedocument.cpp.
|
virtual |
Create a new CodeBlockWithComments object belonging to this CodeDocument.
- Returns
- the just created CodeBlockWithComments
Implements CodeGenObjectWithTextBlocks.
Definition at line 465 of file codedocument.cpp.
|
virtual |
Create a new HierarchicalCodeBlock object belonging to this CodeDocument.
- Returns
- the just created HierarchicalCodeBlock
Implements CodeGenObjectWithTextBlocks.
Reimplemented in JavaANTCodeDocument.
Definition at line 474 of file codedocument.cpp.
|
protected |
Definition at line 481 of file codedocument.cpp.
|
protectedvirtual |
Reset/clear our inventory of textblocks in this document.
Need to overload method to be able to clear the childTextBlockMap.
Reimplemented from CodeGenObjectWithTextBlocks.
Reimplemented in JavaClassifierCodeDocument, CPPSourceCodeDocument, DClassifierCodeDocument, RubyClassifierCodeDocument, and CPPHeaderCodeDocument.
Definition at line 337 of file codedocument.cpp.
|
virtual |
Save the XMI representation of this object.
- Parameters
-
doc the xmi document root the starting point to append
Reimplemented in ClassifierCodeDocument, and JavaANTCodeDocument.
Definition at line 433 of file codedocument.cpp.
|
protectedvirtual |
Set the class attributes of this object from the passed element node.
Reimplemented from CodeGenObjectWithTextBlocks.
Reimplemented in ClassifierCodeDocument, and JavaANTCodeDocument.
Definition at line 386 of file codedocument.cpp.
|
protectedvirtual |
Set attributes of the node that represents this class in the XMI document.
Reimplemented from CodeGenObjectWithTextBlocks.
Reimplemented in ClassifierCodeDocument, and JavaANTCodeDocument.
Definition at line 356 of file codedocument.cpp.
void CodeDocument::setFileExtension | ( | const QString & | new_var | ) |
Set the value of m_fileExtension.
- Parameters
-
new_var the new value of m_fileExtension
Definition at line 72 of file codedocument.cpp.
void CodeDocument::setFileName | ( | const QString & | new_var | ) |
Set the complete value (name plus any extension) of m_filename.
- Parameters
-
new_var the new value of m_filename
Definition at line 53 of file codedocument.cpp.
void CodeDocument::setHeader | ( | CodeComment * | comment | ) |
Set a Header comment object.
- Parameters
-
comment the comment for the header
Definition at line 173 of file codedocument.cpp.
void CodeDocument::setID | ( | const QString & | new_id | ) |
Set the value of m_ID.
- Parameters
-
new_id the new value of m_ID
Definition at line 133 of file codedocument.cpp.
void CodeDocument::setPackage | ( | UMLPackage * | new_var | ) |
Set the value of m_package.
- Parameters
-
new_var the new value of m_package
Definition at line 91 of file codedocument.cpp.
void CodeDocument::setWriteOutCode | ( | bool | new_var | ) |
Set the value of m_writeOutCode.
Whether or not to write out this code document and any codeblocks, etc that it owns.
- Parameters
-
new_var the new value of m_writeOutCode
Definition at line 153 of file codedocument.cpp.
|
virtual |
Cause this code document to synchronize to current generator policy.
Reimplemented in ClassifierCodeDocument.
Definition at line 328 of file codedocument.cpp.
|
virtual |
Create the string representation of this object.
- Returns
- the created string
Reimplemented in CPPMakefileCodeDocument.
Definition at line 301 of file codedocument.cpp.
|
virtual |
Update the content of this code document.
This is where you should lay out your code document structure of textblocks in the inheriting class, should it have any text in it. Vanilla code documents don't have much to do.. override this with a different version for your own documents.
Reimplemented in ClassifierCodeDocument, JavaClassifierCodeDocument, CPPSourceCodeDocument, DClassifierCodeDocument, RubyClassifierCodeDocument, CPPMakefileCodeDocument, CPPHeaderCodeDocument, and JavaANTCodeDocument.
Definition at line 447 of file codedocument.cpp.
|
protected |
Update the header text of this codedocument (text and status of the head comment).
Definition at line 278 of file codedocument.cpp.
Friends And Related Function Documentation
|
friend |
Definition at line 522 of file codedocument.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 23:06:01 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.