diff options
Diffstat (limited to 'doc/api/HowToAddProgrammingLanguages.dox')
| -rw-r--r-- | doc/api/HowToAddProgrammingLanguages.dox | 38 |
1 files changed, 19 insertions, 19 deletions
diff --git a/doc/api/HowToAddProgrammingLanguages.dox b/doc/api/HowToAddProgrammingLanguages.dox index a5840885..1926d811 100644 --- a/doc/api/HowToAddProgrammingLanguages.dox +++ b/doc/api/HowToAddProgrammingLanguages.dox @@ -4,7 +4,7 @@ /** \page howToAddProgrammingLanguages How to add support for a programming language -\section LSupport List of things to have "complete" support of a given language in KDevelop +\section LSupport List of things to have "complete" support of a given language in TDevelop - Implement interface KDevLanguageSupport - \ref sectionClassWizard @@ -30,12 +30,12 @@ - \ref sectionCompilerPlugins . -List of optional things to support a given language in KDevelop: +List of optional things to support a given language in TDevelop: - \ref sectionEditor - Syntax highlighter - (add to QEditor if not available elsewhere) - \ref sectionBuildTool (make/ant/etc) . -Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to see the current status/features of the programming languages currently supported by KDevelop. +Take a look at \ref LangSupportStatus (doc/api/LangSupportStatus.dox file) to see the current status/features of the programming languages currently supported by TDevelop. @@ -52,8 +52,8 @@ Implementing methods: Should be enough for a language support to start working. -KDevelop ships with KDevLang project template. It is a simple language support prototype that can be used when developing language support plugins with KDevelop. -To use it, start a New Project and select: <code>C++->KDevelop->KDevelop Language Support Plugin</code> in the application wizard. +TDevelop ships with KDevLang project template. It is a simple language support prototype that can be used when developing language support plugins with TDevelop. +To use it, start a New Project and select: <code>C++->TDevelop->TDevelop Language Support Plugin</code> in the application wizard. The template is located in <code>languages/cpp/app_templates/kdevlang</code>, you can change it there if you need. @@ -93,7 +93,7 @@ See <code>cpp</code> and <code>java</code> for examples. In general, class stores can be filled with information without specialized and complex language parsers (take a look at <code>languages/python</code> that have a very simple python parser) but your language support will surely benefit -from having such. There is a hand-written c/c++ parser (<code>lib/cppparser</code>) in KDevelop that might be used for ObjC or related C-based languages. +from having such. There is a hand-written c/c++ parser (<code>lib/cppparser</code>) in TDevelop that might be used for ObjC or related C-based languages. Other (not so complex as c++) languages can be parsed by ANTLR based parsers (library is in lib/antlr). Consult www.antlr.org for a ANTLR documentation and look at <code>languages/java</code>, <code>languages/ada</code> and <code>languages/pascal</code> for an example of using such parsers. @@ -106,13 +106,13 @@ If you write (or have) a language parser, your language support can have and methods - their names, names of source files, location in source files, etc.). Class store libraries can be found at <code>lib/catalog</code> (Catalog) and <code>lib/interfaces</code> (CodeModel). -KDevelop provides class browsers that extract information from a <b>class store</b> and display it in a tree view and toolbar selectors of scopes, classes and methods. +TDevelop provides class browsers that extract information from a <b>class store</b> and display it in a tree view and toolbar selectors of scopes, classes and methods. \subsubsection sectionMemoryClassStore Memory class store CodeModel is the memory class store. It is very efficient and thus it is recommended for using as a project class store. CodeModel libraries are located in <code>lib/interfaces/codemodel.h</code>. The class browser for a CodeModel based stores is <code>parts/classview</code>. \subsubsection sectionPersistantClassStore Persistant class store -Catalog is the persistant class store for KDevelop. Persistant class store can be used as an information storage for code completion but it also can be used as a class store for the project. Take a look at +Catalog is the persistant class store for TDevelop. Persistant class store can be used as an information storage for code completion but it also can be used as a class store for the project. Take a look at <code>languages/cpp</code> for an example of using catalog. Catalog is stored on disk in the database file (Berkeley db) If you use catalog with the project, your class browser will be <code>parts/classbrowser</code>. \subsection sectionCodeCompletion Code completion @@ -136,12 +136,12 @@ and look at <code>languages/ruby/app_templates/rubyhello</code>, <code>languages \subsubsection sectionApplicationImportTemplates Application import templates -KDevelop has the ability to <b>create a new project from existing projects or source code</b>. +TDevelop has the ability to <b>create a new project from existing projects or source code</b>. It scans for project files ('*.tdevelop, *.kdevprj, *.studio, *.pro) and if - it finds a project it extracts the necessary information - it does not find project files it scans for source files (*.cpp, *.java, *.pl, *.py, ...) . -and creates a new KDevelop project in the direcotry the user has chosen. +and creates a new TDevelop project in the direcotry the user has chosen. \subsubsection sectionSourceFileTemplates Source file templates @@ -153,14 +153,14 @@ Consult FileCreatePart (parts/filecreate/README.dox file) and \ref howToAddFileT \subsubsection sectionAbbreviationTemplates Code abbreviation templates -KDevelop has a support for <b>code abbreviations</b> so you can add some predefined abbreviations to your language support. Take <code>languages/cpp/cpptemplates</code> as an example. +TDevelop has a support for <b>code abbreviations</b> so you can add some predefined abbreviations to your language support. Take <code>languages/cpp/cpptemplates</code> as an example. \subsection sectionSourceCodeFormater Source code formater Implement a KDevSourceFormater class interface. To obtain source formater functionality (that is already available to -c-based languages) you can extend astyle library (<code>lib/astyle</code>) that is used by KDevelop to format sources. +c-based languages) you can extend astyle library (<code>lib/astyle</code>) that is used by TDevelop to format sources. Take a look at AStylePart for an example how to do it. \subsection sectionDocumentationTopics Documentation topics @@ -170,13 +170,13 @@ In the end you need to edit the <code>languages/YOURLANGUAGE/doc/Makefile.am</co \subsection sectionDebugger Debugger -The last thing to have a complete language support in KDevelop is to -write a <b>Debugger </b>. KDevelop already provides GDB support +The last thing to have a complete language support in TDevelop is to +write a <b>Debugger </b>. TDevelop already provides GDB support (<code>languages/cpp/debugger</code>) and JDB (java debugger) support (<code>languages/java/debugger</code>). Take a look at them to get inspiration. \subsection sectionCompilerPlugins Compiler plugins -There is an ability to create compiler plugin for KDevelop. Compiler plugin provides the compiler configuration dialog which implements command line compiler options. +There is an ability to create compiler plugin for TDevelop. Compiler plugin provides the compiler configuration dialog which implements command line compiler options. Compiler plugins must implement KDevCompilerOptions interface. @@ -192,14 +192,14 @@ See also \ref howToAddPlugins (doc/api/HowToAddPlugins.dox file) for an informat \section sectionEditor Language Editor -To edit source files KDevelop uses any editor that supports the KTextEditor +To edit source files TDevelop uses any editor that supports the KTextEditor interface. The current supported editors and their features are listed in the \ref EditorsSupportStatus (doc/api/EditorsSupportStatus.dox file) page. In case none of the editors does support advanced editing of sources written in your language (like code folding, syntax highlighting, line -indentation) you can improve QEditor included in KDevelop (<code>editors/qeditor</code>). -By creating QEditorIndenter and QSourceColorizer descendants you can provide the support for an automatic indentation and syntax highlighting that will be available for sure in KDevelop. +indentation) you can improve QEditor included in TDevelop (<code>editors/qeditor</code>). +By creating QEditorIndenter and QSourceColorizer descendants you can provide the support for an automatic indentation and syntax highlighting that will be available for sure in TDevelop. @@ -209,7 +209,7 @@ By creating QEditorIndenter and QSourceColorizer descendants you can provide the \section sectionBuildTool Build Tool The language support is important, but it is unusable without a <b>build tool</b> -that can manage projects written on this language. KDevelop +that can manage projects written on this language. TDevelop currently provides several build tools. They are: - ANT build tool |