diff options
author | Dimitri van Heesch <doxygen@gmail.com> | 2021-04-11 19:22:59 (GMT) |
---|---|---|
committer | Dimitri van Heesch <doxygen@gmail.com> | 2021-04-22 17:34:13 (GMT) |
commit | 592aaa4f17d73ec8c475df0f44efaea8cc4d575c (patch) | |
tree | 3cfd68cec756661045ee25c906a8d8f4bddf7a6a /src/rtfgen.h | |
parent | 98c67549bc3cd855873e0ef5eeab7c6410699d78 (diff) | |
download | Doxygen-592aaa4f17d73ec8c475df0f44efaea8cc4d575c.zip Doxygen-592aaa4f17d73ec8c475df0f44efaea8cc4d575c.tar.gz Doxygen-592aaa4f17d73ec8c475df0f44efaea8cc4d575c.tar.bz2 |
Refactoring: remove implicit conversion from QCString to const char *
This commit changes the following in relation to string use
- The implicit convert from 'QCString' to 'const char *' is removed
- Strings parameters use 'const QCString &' as much as possible in favor
over 'const char *'
- 'if (s)' where s is a QCString has been replaced by 'if(!s.isEmpty())'
- data() now always returns a valid C-string and not a 0-pointer.
- when passing a string 's' to printf and related functions 'qPrint(s)' is
used instead of 's.data()'
- for empty string arguments 'QCString()' is used instead of '0'
- The copy() operation has been removed
- Where possible 'qstrcmp(a,b)==0' has been replaces by 'a==b' and
'qstrcmp(a,b)<0' has been replaced by 'a<b'
- Parameters of string type that were default initialized with '= 0' are
no initialized with '= QCString()'
Diffstat (limited to 'src/rtfgen.h')
-rw-r--r-- | src/rtfgen.h | 132 |
1 files changed, 66 insertions, 66 deletions
diff --git a/src/rtfgen.h b/src/rtfgen.h index 344121c..c9a069e 100644 --- a/src/rtfgen.h +++ b/src/rtfgen.h @@ -41,28 +41,28 @@ class RTFGenerator : public OutputGenerator void writeDoc(DocNode *,const Definition *,const MemberDef *,int); - void startFile(const char *name,const char *manName,const char *title,int id); + void startFile(const QCString &name,const QCString &manName,const QCString &title,int id); void writeSearchInfo() {} - void writeFooter(const char *) {} + void writeFooter(const QCString &) {} void endFile(); void clearBuffer(); //void postProcess(QByteArray &); void startIndexSection(IndexSections); void endIndexSection(IndexSections); - void writePageLink(const char *,bool); + void writePageLink(const QCString &,bool); void startProjectNumber(); void endProjectNumber(); void writeStyleInfo(int part); - void startTitleHead(const char *); + void startTitleHead(const QCString &); void startTitle(); - void endTitleHead(const char *,const char *name); + void endTitleHead(const QCString &,const QCString &name); void endTitle() {} void newParagraph(); - void startParagraph(const char *classDef); + void startParagraph(const QCString &classDef); void endParagraph(); - void writeString(const char *text); + void writeString(const QCString &text); void startIndexListItem(); void endIndexListItem(); void startIndexList(); @@ -70,24 +70,24 @@ class RTFGenerator : public OutputGenerator void startIndexKey(); void endIndexKey(); void startIndexValue(bool); - void endIndexValue(const char *,bool); + void endIndexValue(const QCString &,bool); void startItemList(); void endItemList(); - void startIndexItem(const char *ref,const char *file); - void endIndexItem(const char *ref,const char *file); - void docify(const char *text); - void codify(const char *text); - void writeObjectLink(const char *ref,const char *file, - const char *anchor,const char *name); - void writeCodeLink(const char *ref, const char *file, - const char *anchor,const char *name, - const char *tooltip); - void writeTooltip(const char *, const DocLinkInfo &, const char *, - const char *, const SourceLinkInfo &, const SourceLinkInfo & + void startIndexItem(const QCString &ref,const QCString &file); + void endIndexItem(const QCString &ref,const QCString &file); + void docify(const QCString &text); + void codify(const QCString &text); + void writeObjectLink(const QCString &ref,const QCString &file, + const QCString &anchor,const QCString &name); + void writeCodeLink(const QCString &ref, const QCString &file, + const QCString &anchor,const QCString &name, + const QCString &tooltip); + void writeTooltip(const QCString &, const DocLinkInfo &, const QCString &, + const QCString &, const SourceLinkInfo &, const SourceLinkInfo & ) {} - void startTextLink(const char *f,const char *anchor); + void startTextLink(const QCString &f,const QCString &anchor); void endTextLink(); - void startHtmlLink(const char *url); + void startHtmlLink(const QCString &url); void endHtmlLink(); void startTypewriter() { m_t << "{\\f2 "; } void endTypewriter() { m_t << "}"; } @@ -101,7 +101,7 @@ class RTFGenerator : public OutputGenerator void endMemberSections() {} void startHeaderSection() {} void endHeaderSection() {} - void startMemberHeader(const char *,int) { startGroupHeader(FALSE); } + void startMemberHeader(const QCString &,int) { startGroupHeader(FALSE); } void endMemberHeader() { endGroupHeader(FALSE); } void startMemberSubtitle(); void endMemberSubtitle(); @@ -113,10 +113,10 @@ class RTFGenerator : public OutputGenerator void endInlineHeader(); void startAnonTypeScope(int) {} void endAnonTypeScope(int) {} - void startMemberItem(const char *,int,const char *); + void startMemberItem(const QCString &,int,const QCString &); void endMemberItem(); void startMemberTemplateParams() {} - void endMemberTemplateParams(const char *,const char *) {} + void endMemberTemplateParams(const QCString &,const QCString &) {} void startCompoundTemplateParams() { startSubsubsection(); } void endCompoundTemplateParams() { endSubsubsection(); } void insertMemberAlign(bool) {} @@ -124,10 +124,10 @@ class RTFGenerator : public OutputGenerator void writeRuler() { rtfwriteRuler_thin(); } - void writeAnchor(const char *fileName,const char *name); - void startCodeFragment(const char *style); - void endCodeFragment(const char *style); - void writeLineNumber(const char *,const char *,const char *,int l); + void writeAnchor(const QCString &fileName,const QCString &name); + void startCodeFragment(const QCString &style); + void endCodeFragment(const QCString &style); + void writeLineNumber(const QCString &,const QCString &,const QCString &,int l); void startCodeLine(bool); void endCodeLine(); void startEmphasis() { m_t << "{\\i "; } @@ -138,16 +138,16 @@ class RTFGenerator : public OutputGenerator void endDescription(); void startDescItem(); void endDescItem(); - void lineBreak(const char *style=0); - void startMemberDoc(const char *,const char *,const char *,const char *,int,int,bool); + void lineBreak(const QCString &style=QCString()); + void startMemberDoc(const QCString &,const QCString &,const QCString &,const QCString &,int,int,bool); void endMemberDoc(bool); - void startDoxyAnchor(const char *,const char *,const char *,const char *,const char *); - void endDoxyAnchor(const char *,const char *); + void startDoxyAnchor(const QCString &,const QCString &,const QCString &,const QCString &,const QCString &); + void endDoxyAnchor(const QCString &,const QCString &); void writeChar(char c); void writeLatexSpacing() {};//{ m_t << "\\hspace{0.3cm}"; } - void writeStartAnnoItem(const char *type,const char *file, - const char *path,const char *name); - void writeEndAnnoItem(const char *name); + void writeStartAnnoItem(const QCString &type,const QCString &file, + const QCString &path,const QCString &name); + void writeEndAnnoItem(const QCString &name); void startSubsection(); void endSubsection(); void startSubsubsection(); @@ -157,42 +157,42 @@ class RTFGenerator : public OutputGenerator void startSmall() { m_t << "{\\sub "; } void endSmall() { m_t << "}"; } - void startMemberDescription(const char *,const char *,bool); + void startMemberDescription(const QCString &,const QCString &,bool); void endMemberDescription(); void startMemberDeclaration() {} - void endMemberDeclaration(const char *,const char *) {} - void writeInheritedSectionTitle(const char *,const char *,const char *, - const char *,const char *,const char *) {} + void endMemberDeclaration(const QCString &,const QCString &) {} + void writeInheritedSectionTitle(const QCString &,const QCString &,const QCString &, + const QCString &,const QCString &,const QCString &) {} void startDescList(SectionTypes); void startExamples(); void endExamples(); - void startParamList(ParamListTypes,const char *); + void startParamList(ParamListTypes,const QCString &); void endParamList(); //void writeDescItem(); void startDescForItem(); void endDescForItem(); - void startSection(const char *,const char *,SectionType); - void endSection(const char *,SectionType); - void addIndexItem(const char *,const char *); + void startSection(const QCString &,const QCString &,SectionType); + void endSection(const QCString &,SectionType); + void addIndexItem(const QCString &,const QCString &); void startIndent(); void endIndent(); void writeSynopsis() {} void startClassDiagram(); - void endClassDiagram(const ClassDiagram &,const char *filename,const char *name); + void endClassDiagram(const ClassDiagram &,const QCString &filename,const QCString &name); void startPageRef(); - void endPageRef(const char *,const char *); + void endPageRef(const QCString &,const QCString &); void startQuickIndices() {} void endQuickIndices() {} - void writeSplitBar(const char *) {} - void writeNavigationPath(const char *) {} + void writeSplitBar(const QCString &) {} + void writeNavigationPath(const QCString &) {} void writeLogo() {} - void writeQuickLinks(bool,HighlightedItem,const char *) {} - void writeSummaryLink(const char *,const char *,const char *,bool) {} + void writeQuickLinks(bool,HighlightedItem,const QCString &) {} + void writeSummaryLink(const QCString &,const QCString &,const QCString &,bool) {} void startContents() {} void endContents() {} void writeNonBreakableSpace(int); - void startDescTable(const char *title); + void startDescTable(const QCString &title); void endDescTable(); void startDescTableRow(); void endDescTableRow(); @@ -228,15 +228,15 @@ class RTFGenerator : public OutputGenerator void endMemberDocPrefixItem() {} void startMemberDocName(bool) {} void endMemberDocName() {} - void startParameterType(bool,const char *); + void startParameterType(bool,const QCString &); void endParameterType(); void startParameterName(bool) {} void endParameterName(bool,bool,bool) {} void startParameterList(bool) {} void endParameterList() {} - void exceptionEntry(const char*,bool); + void exceptionEntry(const QCString &,bool); - void startConstraintList(const char *); + void startConstraintList(const QCString &); void startConstraintParam(); void endConstraintParam(); void startConstraintType(); @@ -255,25 +255,25 @@ class RTFGenerator : public OutputGenerator void endInlineMemberDoc(); void startLabels(); - void writeLabel(const char *l,bool isLast); + void writeLabel(const QCString &l,bool isLast); void endLabels(); - void startFontClass(const char *); + void startFontClass(const QCString &); void endFontClass(); - void writeCodeAnchor(const char *) {} - void setCurrentDoc(const Definition *,const char *,bool) {} - void addWord(const char *,bool) {} + void writeCodeAnchor(const QCString &) {} + void setCurrentDoc(const Definition *,const QCString &,bool) {} + void addWord(const QCString &,bool) {} - static bool preProcessFileInplace(const char *path,const char *name); + static bool preProcessFileInplace(const QCString &path,const QCString &name); private: - const char *rtf_BList_DepthStyle(); - const char *rtf_CList_DepthStyle(); - const char *rtf_EList_DepthStyle(); - const char *rtf_LCList_DepthStyle(); - const char *rtf_DList_DepthStyle(); - const char *rtf_Code_DepthStyle(); + QCString rtf_BList_DepthStyle(); + QCString rtf_CList_DepthStyle(); + QCString rtf_EList_DepthStyle(); + QCString rtf_LCList_DepthStyle(); + QCString rtf_DList_DepthStyle(); + QCString rtf_Code_DepthStyle(); void incrementIndentLevel(); void decrementIndentLevel(); void beginRTFDocument(); @@ -283,7 +283,7 @@ class RTFGenerator : public OutputGenerator void rtfwriteRuler_emboss(); void rtfwriteRuler_thick(); void rtfwriteRuler_thin(); - void writeRTFReference(const char *label); + void writeRTFReference(const QCString &label); QCString m_sourceFileName; int m_col = 0; |