You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
588 lines
18 KiB
588 lines
18 KiB
/***************************************************************************
|
|
* *
|
|
* This program is free software; you can redistribute it and/or modify *
|
|
* it under the terms of the GNU General Public License as published by *
|
|
* the Free Software Foundation; either version 2 of the License, or *
|
|
* (at your option) any later version. *
|
|
* *
|
|
* copyright (C) 2003-2006 *
|
|
* Umbrello UML Modeller Authors <uml-devel@uml.sf.net> *
|
|
***************************************************************************/
|
|
|
|
/* This code generated by:
|
|
* Author : thomas
|
|
* Date : Fri Jun 20 2003
|
|
*/
|
|
|
|
// own header
|
|
#include "codegenerationpolicy.h"
|
|
|
|
//system includes
|
|
#include <cstdlib> //to get the user name
|
|
|
|
// qt includes
|
|
#include <tqstringlist.h>
|
|
#include <tqregexp.h>
|
|
#include <tqtextstream.h>
|
|
#include <tqdatetime.h>
|
|
|
|
// kde includes
|
|
#include <kconfig.h>
|
|
#include <tdeversion.h>
|
|
#include <kdebug.h>
|
|
#include <kstandarddirs.h>
|
|
|
|
// app includes
|
|
#include "uml.h"
|
|
#include "umldoc.h"
|
|
#include "dialogs/codegenerationpolicypage.h"
|
|
|
|
using namespace std;
|
|
|
|
#define MAXLINES 256
|
|
|
|
CodeGenerationPolicy::OverwritePolicy CodeGenerationPolicy::defaultOverwritePolicy() const {
|
|
return Ask;
|
|
}
|
|
|
|
bool CodeGenerationPolicy::defaultVerboseSectionComments() const {
|
|
return true;
|
|
}
|
|
|
|
bool CodeGenerationPolicy::defaultVerboseDocumentComments() const {
|
|
return true;
|
|
}
|
|
|
|
bool CodeGenerationPolicy::defaultIncludeHeadings() const {
|
|
return true;
|
|
}
|
|
|
|
CodeGenerationPolicy::NewLineType CodeGenerationPolicy::defaultLineEndingType() const {
|
|
return UNIX;
|
|
}
|
|
|
|
CodeGenerationPolicy::IndentationType CodeGenerationPolicy::defaultIndentType() const {
|
|
return SPACE;
|
|
}
|
|
|
|
int CodeGenerationPolicy::defaultIndentAmount() const {
|
|
return 2;
|
|
}
|
|
|
|
CodeGenerationPolicy::ModifyNamePolicy CodeGenerationPolicy::defaultModifyNamePolicy() const {
|
|
return No;
|
|
}
|
|
|
|
CodeGenerationPolicy::CommentStyle CodeGenerationPolicy::defaultCommentStyle() const {
|
|
return SingleLine;
|
|
}
|
|
|
|
CodeGenerationPolicy::ScopePolicy CodeGenerationPolicy::defaultAttribAccessorScope() const {
|
|
return FromParent;
|
|
}
|
|
|
|
CodeGenerationPolicy::ScopePolicy CodeGenerationPolicy::defaultAssocFieldScope() const {
|
|
return FromParent;
|
|
}
|
|
|
|
bool CodeGenerationPolicy::defaultAutoGenerateConstructors() const {
|
|
return false;
|
|
}
|
|
|
|
|
|
// Constructors/Destructors
|
|
//
|
|
|
|
CodeGenerationPolicy::CodeGenerationPolicy(CodeGenerationPolicy * clone)
|
|
{
|
|
|
|
initFields();
|
|
setDefaults(clone,false);
|
|
}
|
|
|
|
CodeGenerationPolicy::CodeGenerationPolicy(KConfig * config)
|
|
{
|
|
initFields();
|
|
setDefaults(config,false);
|
|
}
|
|
|
|
CodeGenerationPolicy::~CodeGenerationPolicy ( ) { }
|
|
|
|
//
|
|
// Methods
|
|
//
|
|
|
|
|
|
// Accessor methods
|
|
//
|
|
|
|
|
|
// Public attribute accessor methods
|
|
//
|
|
|
|
/**
|
|
* Set the value of m_overwritePolicy
|
|
* Policy of how to deal with overwriting existing files. Allowed values are "ask",
|
|
* "yes" and "no".
|
|
* @param new_var the new value of m_overwritePolicy
|
|
*/
|
|
void CodeGenerationPolicy::setOverwritePolicy ( OverwritePolicy new_var ) {
|
|
m_overwritePolicy = new_var;
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_overwritePolicy
|
|
* Policy of how to deal with overwriting existing files. Allowed values are "ask",
|
|
* "yes" and "no".
|
|
* @return the value of m_overwritePolicy
|
|
*/
|
|
CodeGenerationPolicy::OverwritePolicy CodeGenerationPolicy::getOverwritePolicy ( ) const {
|
|
return m_overwritePolicy;
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_commentStyle
|
|
* @param new_var the new value of m_commentStyle
|
|
*/
|
|
void CodeGenerationPolicy::setCommentStyle ( CommentStyle new_var ) {
|
|
m_commentStyle = new_var;
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_commentStyle
|
|
* @return the value of m_commentStyle
|
|
*/
|
|
CodeGenerationPolicy::CommentStyle CodeGenerationPolicy::getCommentStyle ( ) {
|
|
return m_commentStyle;
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_codeVerboseSectionComments
|
|
* Whether or not verbose code commenting for sections is desired. If true, comments
|
|
* for sections will be written even if the section is empty.
|
|
* @param new_var the new value of m_codeVerboseSectionComments
|
|
*/
|
|
void CodeGenerationPolicy::setCodeVerboseSectionComments ( bool new_var ) {
|
|
m_codeVerboseSectionComments = new_var;
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_codeVerboseSectionComments
|
|
* Whether or not verbose code commenting for sections is desired. If true, comments
|
|
* for sections will be written even if the section is empty.
|
|
* @return the value of m_codeVerboseSectionComments
|
|
*/
|
|
bool CodeGenerationPolicy::getCodeVerboseSectionComments ( ) const {
|
|
return m_codeVerboseSectionComments;
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_codeVerboseDocumentComments
|
|
* Whether or not verbose code commenting for documentation is desired. If true,
|
|
* documentation for various code will be written even if no code would normally be
|
|
* created at that point in the file.
|
|
* @param new_var the new value of m_codeVerboseDocumentComments
|
|
*/
|
|
void CodeGenerationPolicy::setCodeVerboseDocumentComments ( bool new_var ) {
|
|
m_codeVerboseDocumentComments = new_var;
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_codeVerboseDocumentComments
|
|
* Whether or not verbose code commenting for documentation is desired. If true,
|
|
* documentation for various code will be written even if no code would normally be
|
|
* created at that point in the file.
|
|
* @return the value of m_codeVerboseDocumentComments
|
|
*/
|
|
bool CodeGenerationPolicy::getCodeVerboseDocumentComments ( ) const {
|
|
return m_codeVerboseDocumentComments;
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_headingFileDir
|
|
* location of the header file template.
|
|
* @param new_var the new value of m_headingFileDir
|
|
*/
|
|
void CodeGenerationPolicy::setHeadingFileDir ( const TQString & path) {
|
|
m_headingFiles.setPath(path);
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_headingFileDir
|
|
* location of the header file template.
|
|
* @return the value of m_headingFileDir
|
|
*/
|
|
TQString CodeGenerationPolicy::getHeadingFileDir ( ) const {
|
|
return m_headingFiles.absPath();
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_includeHeadings
|
|
* @param new_var the new value of m_includeHeadings
|
|
*/
|
|
void CodeGenerationPolicy::setIncludeHeadings ( bool new_var ) {
|
|
m_includeHeadings = new_var;
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_includeHeadings
|
|
* @return the value of m_includeHeadings
|
|
*/
|
|
bool CodeGenerationPolicy::getIncludeHeadings ( ) const {
|
|
return m_includeHeadings;
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_outputDirectory
|
|
* location of where output files will go.
|
|
* @param new_var the new value of m_outputDirectory
|
|
*/
|
|
void CodeGenerationPolicy::setOutputDirectory ( TQDir new_var ) {
|
|
m_outputDirectory = new_var;
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_outputDirectory
|
|
* location of where output files will go.
|
|
* @return the value of m_outputDirectory
|
|
*/
|
|
TQDir CodeGenerationPolicy::getOutputDirectory ( ) {
|
|
return m_outputDirectory;
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_lineEndingType
|
|
* What line ending characters to use.
|
|
* @param new_var the new value of m_lineEndingType
|
|
*/
|
|
void CodeGenerationPolicy::setLineEndingType ( NewLineType type) {
|
|
m_lineEndingType = type;
|
|
switch (m_lineEndingType) {
|
|
case MAC:
|
|
m_lineEndingChars = TQString("\r\n");
|
|
break;
|
|
case DOS:
|
|
m_lineEndingChars = TQString("\r");
|
|
break;
|
|
case UNIX:
|
|
default:
|
|
m_lineEndingChars = TQString("\n");
|
|
break;
|
|
}
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_lineEndingType
|
|
* What line ending characters to use.
|
|
* @return the value of m_lineEndingType
|
|
*/
|
|
CodeGenerationPolicy::NewLineType CodeGenerationPolicy::getLineEndingType ( ) {
|
|
return m_lineEndingType;
|
|
}
|
|
|
|
/** Utility function to get the actual characters.
|
|
*/
|
|
TQString CodeGenerationPolicy::getNewLineEndingChars ( ) const {
|
|
return m_lineEndingChars;
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_indentationType
|
|
* The amount and type of whitespace to indent with.
|
|
* @param new_var the new value of m_indentationType
|
|
*/
|
|
void CodeGenerationPolicy::setIndentationType ( IndentationType new_var ) {
|
|
m_indentationType = new_var;
|
|
calculateIndentation();
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
CodeGenerationPolicy::IndentationType CodeGenerationPolicy::getIndentationType ( ) {
|
|
return m_indentationType;
|
|
}
|
|
|
|
void CodeGenerationPolicy::setIndentationAmount ( int amount ) {
|
|
if(amount > -1)
|
|
{
|
|
m_indentationAmount = amount;
|
|
calculateIndentation();
|
|
emit modifiedCodeContent();
|
|
}
|
|
}
|
|
|
|
int CodeGenerationPolicy::getIndentationAmount ( ) {
|
|
return m_indentationAmount;
|
|
}
|
|
|
|
/**
|
|
* Utility method to get the amount (and type of whitespace) to indent with.
|
|
* @return the value of the indentation
|
|
*/
|
|
TQString CodeGenerationPolicy::getIndentation ( ) const {
|
|
return m_indentation;
|
|
}
|
|
|
|
void CodeGenerationPolicy::calculateIndentation ( ) {
|
|
TQString indent = "";
|
|
m_indentation = "";
|
|
switch (m_indentationType) {
|
|
case NONE:
|
|
break;
|
|
case TAB:
|
|
indent = TQString("\t");
|
|
break;
|
|
default:
|
|
case SPACE:
|
|
indent = TQString(" ");
|
|
break;
|
|
}
|
|
|
|
for (int i=0; i < m_indentationAmount; i++)
|
|
m_indentation += indent;
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_modifyPolicy
|
|
* @param new_var the new value of m_modifyPolicy
|
|
*/
|
|
void CodeGenerationPolicy::setModifyPolicy ( ModifyNamePolicy new_var ) {
|
|
m_modifyPolicy = new_var;
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_modifyPolicy
|
|
* @return the value of m_modifyPolicy
|
|
*/
|
|
CodeGenerationPolicy::ModifyNamePolicy CodeGenerationPolicy::getModifyPolicy ( ) const {
|
|
return m_modifyPolicy;
|
|
}
|
|
|
|
/**
|
|
* Set the value of m_autoGenerateConstructors
|
|
* @param new_var the new value
|
|
*/
|
|
void CodeGenerationPolicy::setAutoGenerateConstructors( bool var ) {
|
|
m_autoGenerateConstructors = var;
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
/**
|
|
* Get the value of m_autoGenerateConstructors
|
|
* @return the value of m_autoGenerateConstructors
|
|
*/
|
|
bool CodeGenerationPolicy::getAutoGenerateConstructors( ){
|
|
return m_autoGenerateConstructors;
|
|
}
|
|
|
|
void CodeGenerationPolicy::setAttributeAccessorScope(ScopePolicy var) {
|
|
m_attributeAccessorScope = var;
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
CodeGenerationPolicy::ScopePolicy CodeGenerationPolicy::getAttributeAccessorScope() {
|
|
return m_attributeAccessorScope;
|
|
}
|
|
|
|
void CodeGenerationPolicy::setAssociationFieldScope(ScopePolicy var) {
|
|
m_associationFieldScope = var;
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
CodeGenerationPolicy::ScopePolicy CodeGenerationPolicy::getAssociationFieldScope() {
|
|
return m_associationFieldScope;
|
|
}
|
|
|
|
/**
|
|
* Create a new dialog interface for this object.
|
|
* @return dialog object
|
|
*/
|
|
CodeGenerationPolicyPage * CodeGenerationPolicy::createPage ( TQWidget *pWidget, const char *name ) {
|
|
return new CodeGenerationPolicyPage ( pWidget, name, 0 );
|
|
}
|
|
|
|
// Other methods
|
|
//
|
|
|
|
void CodeGenerationPolicy::emitModifiedCodeContentSig() {
|
|
if (!UMLApp::app()->getDocument()->loading())
|
|
emit modifiedCodeContent();
|
|
}
|
|
|
|
void CodeGenerationPolicy::setDefaults ( CodeGenerationPolicy * clone , bool emitUpdateSignal)
|
|
{
|
|
|
|
if(!clone)
|
|
return;
|
|
|
|
blockSignals(true); // we need to do this because otherwise most of these
|
|
// settors below will each send the modifiedCodeContent() signal
|
|
// needlessly (we can just make one call at the end).
|
|
|
|
setCodeVerboseSectionComments ( clone->getCodeVerboseSectionComments() );
|
|
setCodeVerboseDocumentComments ( clone->getCodeVerboseDocumentComments() );
|
|
setHeadingFileDir ( clone->getHeadingFileDir());
|
|
setIncludeHeadings ( clone->getIncludeHeadings());
|
|
setOutputDirectory ( clone->getOutputDirectory());
|
|
setLineEndingType ( clone->getLineEndingType());
|
|
setIndentationAmount ( clone->getIndentationAmount());
|
|
setIndentationType ( clone->getIndentationType());
|
|
setModifyPolicy ( clone->getModifyPolicy());
|
|
setOverwritePolicy ( clone->getOverwritePolicy() );
|
|
|
|
blockSignals(false); // "as you were citizen"
|
|
|
|
if(emitUpdateSignal)
|
|
emit modifiedCodeContent();
|
|
|
|
}
|
|
|
|
void CodeGenerationPolicy::setDefaults( KConfig * config, bool emitUpdateSignal)
|
|
{
|
|
|
|
if(!config)
|
|
return;
|
|
|
|
blockSignals(true); // we need to do this because otherwise most of these
|
|
// settors below will each send the modifiedCodeContent() signal
|
|
// needlessly (we can just make one call at the end).
|
|
|
|
config -> setGroup("Code Generation");
|
|
setAttributeAccessorScope((ScopePolicy)config->readNumEntry("defaultAttributeAccessorScope",defaultAttribAccessorScope()));
|
|
setAssociationFieldScope((ScopePolicy)config->readNumEntry("defaultAssocFieldScope",defaultAssocFieldScope()));
|
|
setCommentStyle((CommentStyle)config->readNumEntry("commentStyle",defaultCommentStyle()));
|
|
setAutoGenerateConstructors(config->readBoolEntry("autoGenEmptyConstructors",defaultAutoGenerateConstructors()));
|
|
setCodeVerboseDocumentComments( config->readBoolEntry("forceDoc",defaultVerboseDocumentComments()) );
|
|
setCodeVerboseSectionComments( config->readBoolEntry("forceSections",defaultVerboseSectionComments()) );
|
|
setLineEndingType( (NewLineType) config->readNumEntry("lineEndingType",defaultLineEndingType()) );
|
|
setIndentationType( (IndentationType) config->readNumEntry("indentationType",defaultIndentType()) );
|
|
setIndentationAmount( config->readNumEntry("indentationAmount",defaultIndentAmount()));
|
|
|
|
TQString path = config -> readPathEntry("outputDirectory");
|
|
if(path.isEmpty())
|
|
path = TQDir::homeDirPath() + "/uml-generated-code/";
|
|
setOutputDirectory ( TQDir (path) );
|
|
|
|
path = config -> readPathEntry("headingsDirectory");
|
|
if(path.isEmpty()) {
|
|
KStandardDirs stddirs;
|
|
path = stddirs.findDirs("data","umbrello/headings").first();
|
|
}
|
|
setHeadingFileDir ( path );
|
|
|
|
setIncludeHeadings( config->readBoolEntry("includeHeadings",defaultIncludeHeadings()) );
|
|
setOverwritePolicy( (OverwritePolicy)config->readNumEntry("overwritePolicy",defaultOverwritePolicy()));
|
|
setModifyPolicy( (ModifyNamePolicy)config->readNumEntry("modnamePolicy",defaultModifyNamePolicy()));
|
|
|
|
blockSignals(false); // "as you were citizen"
|
|
|
|
if(emitUpdateSignal)
|
|
emit modifiedCodeContent();
|
|
|
|
}
|
|
|
|
void CodeGenerationPolicy::writeConfig (KConfig * config) {
|
|
|
|
config->setGroup("Code Generation");
|
|
|
|
config->writeEntry("defaultAttributeAccessorScope",getAttributeAccessorScope());
|
|
config->writeEntry("defaultAssocFieldScope",getAssociationFieldScope());
|
|
config->writeEntry("commentStyle",getCommentStyle());
|
|
config->writeEntry("autoGenEmptyConstructors",getAutoGenerateConstructors());
|
|
//config->writeEntry("newCodegen", getNewCodegen());
|
|
config->writeEntry("forceDoc",getCodeVerboseDocumentComments());
|
|
config->writeEntry("forceSections",getCodeVerboseSectionComments());
|
|
|
|
config->writeEntry("lineEndingType",getLineEndingType());
|
|
config->writeEntry("indentationType",getIndentationType());
|
|
config->writeEntry("indentationAmount",getIndentationAmount());
|
|
|
|
config->writePathEntry("outputDirectory",getOutputDirectory().absPath());
|
|
config->writePathEntry("headingsDirectory",getHeadingFileDir());
|
|
config->writeEntry("includeHeadings",getIncludeHeadings());
|
|
config->writeEntry("overwritePolicy",getOverwritePolicy());
|
|
config->writeEntry("modnamePolicy", getModifyPolicy());
|
|
|
|
}
|
|
|
|
// return the actual text
|
|
TQString CodeGenerationPolicy::getHeadingFile(const TQString& str) {
|
|
|
|
if(!getIncludeHeadings() || str.isEmpty())
|
|
return TQString("");
|
|
if(str.contains(" ") ||str.contains(";")) {
|
|
kWarning() << "File folder must not have spaces or semi colons!" << endl;
|
|
return TQString("");
|
|
}
|
|
//if we only get the extension, then we look for the default
|
|
// heading.[extension]. If there is no such file, we try to
|
|
// get any file with the same extension
|
|
TQString filename;
|
|
if(str.startsWith(".")) {
|
|
if(TQFile::exists(m_headingFiles.absFilePath("heading"+str)))
|
|
filename = m_headingFiles.absFilePath("heading"+str);
|
|
else {
|
|
m_headingFiles.setNameFilter('*' + str);
|
|
//if there is more than one match we just take the first one
|
|
filename = m_headingFiles.absFilePath(m_headingFiles.entryList().first());
|
|
// kWarning() << "header file name set to " << filename << " because it was *" << endl;
|
|
}
|
|
} else { //we got a file name (not only extension)
|
|
filename = m_headingFiles.absFilePath(str);
|
|
}
|
|
|
|
TQFile f(filename);
|
|
if(!f.open(IO_ReadOnly)) {
|
|
// kWarning() << "Error opening heading file: " << f.name() << endl;
|
|
// kWarning() << "Headings directory was " << m_headingFiles.absPath() << endl;
|
|
return TQString("");
|
|
}
|
|
|
|
TQTextStream ts(&f);
|
|
TQString retstr = TQString("");
|
|
TQString endLine = getNewLineEndingChars();
|
|
for(int l = 0; l < MAXLINES && !ts.atEnd(); l++)
|
|
retstr += ts.readLine()+endLine;
|
|
|
|
//do variable substitution
|
|
retstr.replace( TQRegExp("%author%"),TQString(getenv("USER"))); //get the user name from some where else
|
|
retstr.replace( TQRegExp("%headingpath%"),filename );
|
|
retstr.replace( TQRegExp("%time%"), TQTime::currentTime().toString());
|
|
retstr.replace( TQRegExp("%date%"), TQDate::tqcurrentDate().toString());
|
|
// the replace filepath, time parts are also in the code document updateHeader method
|
|
// (which is not a virtual function)...
|
|
|
|
return retstr;
|
|
}
|
|
|
|
void CodeGenerationPolicy::initFields ( ) {
|
|
|
|
blockSignals(true);
|
|
|
|
m_overwritePolicy = defaultOverwritePolicy();
|
|
m_codeVerboseSectionComments = defaultVerboseSectionComments();
|
|
m_codeVerboseDocumentComments = defaultVerboseDocumentComments();
|
|
m_includeHeadings = defaultIncludeHeadings();
|
|
setLineEndingType(defaultLineEndingType());
|
|
m_indentationType = defaultIndentType();
|
|
m_indentationAmount = defaultIndentAmount();
|
|
m_modifyPolicy = defaultModifyNamePolicy();
|
|
m_autoGenerateConstructors = defaultAutoGenerateConstructors();
|
|
m_attributeAccessorScope = defaultAttribAccessorScope();
|
|
m_associationFieldScope = defaultAssocFieldScope();
|
|
m_commentStyle = defaultCommentStyle();
|
|
|
|
m_outputDirectory.setPath(TQDir::home().absPath() + "/uml-generated-code/");
|
|
m_headingFiles.setPath(TQDir::home().absPath() + "/headings/");
|
|
|
|
calculateIndentation();
|
|
|
|
blockSignals(false);
|
|
}
|
|
|
|
#include "codegenerationpolicy.moc"
|