From 338446ad72d3581745020aa78783f4b4d4afe4cb Mon Sep 17 00:00:00 2001 From: Christoph Schlosser Date: Sat, 7 Oct 2017 14:57:01 +0200 Subject: Add C parser and generator --- src/DocGen/CppGen.ts | 153 +-------------------------------------------------- 1 file changed, 3 insertions(+), 150 deletions(-) (limited to 'src/DocGen/CppGen.ts') diff --git a/src/DocGen/CppGen.ts b/src/DocGen/CppGen.ts index 1dc70f7..c13d194 100644 --- a/src/DocGen/CppGen.ts +++ b/src/DocGen/CppGen.ts @@ -1,153 +1,6 @@ import { Position, Range, Selection, TextEditor, TextLine, WorkspaceEdit } from "vscode"; -import { DoxygenCommands, IDocGen } from "./DocGen"; +import CGen from "./CGen"; -export default class CppGen implements IDocGen { - private lineStart: string; - private endComment: string; - private commandIndicator: string; - private spaceAfterCommand: string; - private activeEditor: TextEditor; - private position: Position; - private comment: string; - private retVals: string[]; - private params: string[]; - - /** - * @param {TextEditor} actEdit Active editor window - * @param {Position} cursorPosition Where the cursor of the user currently is - * @param {string[]} param The parameter names of the method extracted by the parser - * @param {string[]} returnVals The return values extracted by the parser - */ - public constructor(actEdit: TextEditor, cursorPosition: Position, param: string[], returnVals: string[]) { - this.activeEditor = actEdit; - this.position = cursorPosition; - this.comment = "\n"; // Add the new line after the comment indicator - this.params = param; - this.retVals = returnVals; - } - - /** - * @inheritdoc - */ - public GenerateDoc() { - this.readConfig(); - this.generateComment(); - - const oldPos: Position = this.position; - - const active: Position = this.activeEditor.selection.active; - const anchor: Position = new Position(active.line + 1, active.character); // Start at the next line - const replaceSelection = new Selection(anchor, active); - this.activeEditor.edit((editBuilder) => { - editBuilder.replace(replaceSelection, this.comment); // Insert the comment - }); - - // Set cursor after brief command - this.setCursor(oldPos.line + 3, oldPos.character); - const newSelectActive = new Position(oldPos.line + 3, oldPos.character + DoxygenCommands.detailed.length); - const newSelectPos = new Position(oldPos.line + 3, oldPos.character); - this.activeEditor.selection = new Selection(newSelectPos, newSelectActive); - } - - /*************************************************************************** - Implementation - ***************************************************************************/ - - private readConfig() { - this.lineStart = " * "; // TODO: make this customizable - this.endComment = "*/"; // TODO: make this customizable - this.commandIndicator = "@"; // TODO: make this customizable - this.spaceAfterCommand = " "; // TODO: make this customizable - } - - private indentLine(commentLine: string): string { - const line: TextLine = this.activeEditor.document.lineAt(this.activeEditor.selection.start.line); - const lineTxt: string = line.text; - let stringToIndent: string = ""; - // Find indentation from previous line - for (let i = 0; i < line.firstNonWhitespaceCharacterIndex; i++) { - if (lineTxt.charAt(i) === "\t") { - stringToIndent = stringToIndent + "\t"; - } else if (lineTxt.charAt(i) === " ") { - stringToIndent = stringToIndent + " "; - } - } - const textToInsert = stringToIndent + commentLine; - return textToInsert; - } - - private generateBrief() { - let line: string = ""; - line += this.lineStart; - line += this.commandIndicator; - line += DoxygenCommands.brief; - line += this.spaceAfterCommand; - this.comment += this.indentLine(line); - } - - private generateDetailed() { - let line: string = ""; - line += this.lineStart; - line += "\n"; - this.comment += this.indentLine(line); - line = this.lineStart; - line += DoxygenCommands.detailed + "\n"; - this.comment += this.indentLine(line); - line = this.lineStart; - this.comment += this.indentLine(line); - } - - private generateParams() { - let line: string = ""; - - this.params.forEach((element: string) => { - line = this.lineStart; - line += this.commandIndicator; - line += DoxygenCommands.param + " "; // TODO: Make this customizable - line += element + "\n"; - this.comment += this.indentLine(line); - }); - } - - private generateReturn() { - let line: string = ""; - - this.retVals.forEach((element: string) => { - line = this.lineStart; - line += this.commandIndicator; - line += DoxygenCommands.return + " "; // TODO: Make this customizable - line += element + "\n"; - this.comment += this.indentLine(line); - }); - } - - private generateEnd() { - let line: string = " "; // TODO: Make this customizable - line += this.endComment; - this.comment += this.indentLine(line); - } - - private generateComment() { - this.generateBrief(); - this.comment += "\n"; - this.generateDetailed(); - this.comment += "\n"; - if (this.params.length !== 0) { // Only if we have parameters - this.generateParams(); - } - if (this.retVals.length !== 0) { // Only if we have return values - if (this.params.length !== 0) { - const line: string = this.lineStart + "\n"; - this.comment += this.indentLine(line); - } - this.generateReturn(); - } - this.generateEnd(); - } - - private setCursor(line: number, character: number) { - const indentLen: number = this.indentLine("").length; - const move: Selection = new Selection(line, character, line, character); - this.activeEditor.selection = move; - } +export default class CppGen extends CGen { + // For now C++ is the same as C } -- cgit v1.2.3