umbrello 25.07.70
Umbrello UML Modeller is a Unified Modelling Language (UML) diagram program based on KDE Technology
Public Member Functions | Protected Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
JavaCsValaImportBase Class Referenceabstract

#include <javacsvalaimportbase.h>

Inheritance diagram for JavaCsValaImportBase:
NativeImportBase ClassImport CsValaImportBase JavaImport CSharpImport ValaImport

Public Member Functions

 JavaCsValaImportBase (CodeImpThread *thread=nullptr)
 
virtual ~JavaCsValaImportBase ()
 
virtual QString fileExtension ()=0
 
- Public Member Functions inherited from NativeImportBase
 NativeImportBase (const QString &singleLineCommentIntro, CodeImpThread *thread=nullptr)
 
virtual ~NativeImportBase ()
 
- Public Member Functions inherited from ClassImport
 ClassImport (CodeImpThread *thread=nullptr)
 
virtual ~ClassImport ()
 
bool importFiles (const QStringList &fileNames)
 
bool importFile (const QString &fileName)
 
void setRootPath (const QString &path)
 
bool enabled () const
 

Protected Member Functions

void initVars ()
 
void fillSource (const QString &word)
 
bool parseFile (const QString &filename)
 
virtual void spawnImport (const QString &file)=0
 
UMLObjectresolveClass (const QString &className)
 
QString joinTypename (const QString &typeName)
 
bool parseClassDeclaration (const QString &keyword)
 
bool parseEnumDeclaration ()
 
- Protected Member Functions inherited from NativeImportBase
void initialize ()
 
void setMultiLineComment (const QString &intro, const QString &end)
 
void setMultiLineAltComment (const QString &intro, const QString &end)
 
void scan (const QString &line)
 
virtual bool preprocess (QString &line)
 
virtual QStringList split (const QString &line)
 
virtual bool parseStmt ()=0
 
void skipStmt (const QString &until=QStringLiteral(";"))
 
bool skipToClosing (QChar opener)
 
QString current ()
 
QString lookAhead ()
 
virtual QString advance ()
 
void pushScope (UMLPackage *p)
 
UMLPackagepopScope ()
 
UMLPackagecurrentScope ()
 
int scopeIndex ()
 
- Protected Member Functions inherited from ClassImport
virtual void initPerFile ()
 
void log (const QString &file, const QString &text)
 
void log (const QString &text)
 

Static Protected Member Functions

static UMLObjectfindObject (const QString &name, UMLPackage *parentPkg)
 

Protected Attributes

bool m_isStatic
 static flag for the member var or method
 
QString m_currentFileName
 current filename being parsed
 
QString m_currentPackage
 current package of the file being parsed
 
QStringList m_imports
 imports included in the current file
 
Uml::Visibility::Enum m_defaultCurrentAccess
 current visibility for when the visibility is absent
 
Uml::ProgrammingLanguage::Enum m_language
 
- Protected Attributes inherited from NativeImportBase
QString m_singleLineCommentIntro
 start token of a single line comment
 
QStringList m_source
 the scanned lexemes
 
int m_srcIndex
 used for indexing m_source
 
QList< UMLPackage * > m_scope
 stack of scopes for use by the specific importer
 
UMLClassifierm_klass
 class currently being processed
 
Uml::Visibility::Enum m_currentAccess
 current access (public/protected/private)
 
QString m_comment
 intermediate accumulator for comment text
 
bool m_inComment
 
bool m_isAbstract
 accumulator for abstractness
 
QString m_multiLineCommentIntro
 multi line comment delimiter intro
 
QString m_multiLineCommentEnd
 multi line comment delimiter end
 
QString m_multiLineAltCommentIntro
 
QString m_multiLineAltCommentEnd
 
- Protected Attributes inherited from ClassImport
CodeImpThreadm_thread
 thread in which the work of importing is done
 
bool m_enabled
 state of importer
 
QString m_rootPath
 root path of import
 

Static Protected Attributes

static QStringList s_filesAlreadyParsed
 
static int s_parseDepth = 0
 
- Static Protected Attributes inherited from NativeImportBase
static QStringList m_parsedFiles
 

Additional Inherited Members

- Static Public Member Functions inherited from ClassImport
static ClassImportcreateImporterByFileExt (const QString &fileName, CodeImpThread *thread=nullptr)
 

Detailed Description

Base class for Java, C# and Vala code import.

Author
Oliver Kellogg Bugs and comments to umbre.nosp@m.llo-.nosp@m.devel.nosp@m.@kde.nosp@m..org or https://bugs.kde.org

Constructor & Destructor Documentation

◆ JavaCsValaImportBase()

JavaCsValaImportBase::JavaCsValaImportBase ( CodeImpThread thread = nullptr)
explicit

Constructor.

◆ ~JavaCsValaImportBase()

virtual JavaCsValaImportBase::~JavaCsValaImportBase ( )
inlinevirtual

Member Function Documentation

◆ fileExtension()

virtual QString JavaCsValaImportBase::fileExtension ( )
pure virtual

Implemented in CSharpImport, JavaImport, and ValaImport.

◆ fillSource()

void JavaCsValaImportBase::fillSource ( const QString &  word)
protectedvirtual

Implement abstract operation from NativeImportBase.

Parameters
wordwhitespace delimited item

Implements NativeImportBase.

◆ findObject()

UMLObject * JavaCsValaImportBase::findObject ( const QString &  name,
UMLPackage parentPkg 
)
staticprotected

Returns the UML Object if found, or null otherwise.

Parameters
namename of the uml object
parentPkgparent package
Returns
null or the uml objecct

◆ initVars()

void JavaCsValaImportBase::initVars ( )
protectedvirtual

Reimplement operation from NativeImportBase.

Reimplemented from NativeImportBase.

◆ joinTypename()

QString JavaCsValaImportBase::joinTypename ( const QString &  typeName)
protected

Figure out if the type is really an array or template of the given typeName. Catenate possible template arguments/array dimensions to the end of the type name.

Parameters
typeNamethe type name
Returns
the type name with the additional information

◆ parseClassDeclaration()

bool JavaCsValaImportBase::parseClassDeclaration ( const QString &  keyword)
protected

◆ parseEnumDeclaration()

bool JavaCsValaImportBase::parseEnumDeclaration ( )
protected

◆ parseFile()

bool JavaCsValaImportBase::parseFile ( const QString &  filename)
protectedvirtual

Keep track of the current file being parsed and reset the list of imports.

Parameters
filenamethe name of the file being parsed

Reimplemented from NativeImportBase.

◆ resolveClass()

UMLObject * JavaCsValaImportBase::resolveClass ( const QString &  className)
protected

Try to resolve the specified class the current class depends on.

Parameters
classNamethe name of the class

◆ spawnImport()

virtual void JavaCsValaImportBase::spawnImport ( const QString &  file)
protectedpure virtual

Implemented in CSharpImport, JavaImport, and ValaImport.

Member Data Documentation

◆ m_currentFileName

QString JavaCsValaImportBase::m_currentFileName
protected

current filename being parsed

◆ m_currentPackage

QString JavaCsValaImportBase::m_currentPackage
protected

current package of the file being parsed

◆ m_defaultCurrentAccess

Uml::Visibility::Enum JavaCsValaImportBase::m_defaultCurrentAccess
protected

current visibility for when the visibility is absent

◆ m_imports

QStringList JavaCsValaImportBase::m_imports
protected

imports included in the current file

◆ m_isStatic

bool JavaCsValaImportBase::m_isStatic
protected

static flag for the member var or method

◆ m_language

Uml::ProgrammingLanguage::Enum JavaCsValaImportBase::m_language
protected

required for language specific suport

◆ s_filesAlreadyParsed

QStringList JavaCsValaImportBase::s_filesAlreadyParsed
staticprotected

Keep track of the files we have already parsed so we don't reparse the same ones over and over again.

◆ s_parseDepth

int JavaCsValaImportBase::s_parseDepth = 0
staticprotected

Keep track of the parses so that the filesAlreadyParsed can be reset when we're done.


The documentation for this class was generated from the following files: