add option top insert * or + on newline in ddoc, close #138

src/ce_editoroptions.pas

@@ -62,6 +62,7 @@ type
     fPhobosDocRoot: TCEPathname;
     fAlwaysAdvancedFeatures: boolean;
     fAutoClosedPairs: TAutoClosePairs;
+    fSmartDdocNewline: boolean;
     //
     procedure setPhobosDocRoot(value: TCEPathname);
     procedure setFont(value: TFont);
@@ -111,6 +112,7 @@ type
     property rightEdgeColor: TColor read fRightEdgeColor write fRightEdgeColor default clSilver;
     property selection: TSynSelectedColor read fSelAttribs write setSelCol;
     property shortcuts: TCollection read fShortCuts write setShortcuts;
+    property smartDdocNewline: boolean read fSmartDdocNewline write fSmartDdocNewline;
     property tabulationWidth: Integer read fTabWidth write fTabWidth default 4;
   public
     constructor Create(AOwner: TComponent); override;
@@ -303,6 +305,10 @@ begin
     detectIndentMode:=srcopt.detectIndentMode;
     fPhobosDocRoot:=srcopt.fPhobosDocRoot;
 
+    fSmartDdocNewline:=srcopt.fSmartDdocNewline;
+    if fSmartDdocNewline then
+      fOptions1 += [eoAutoIndent];
+
     tabulationWidth := srcopt.tabulationWidth;
     blockIndentation := srcopt.blockIndentation;
     lineSpacing := srcopt.lineSpacing;
@@ -667,6 +673,7 @@ begin
   anEditor.detectIndentMode := detectIndentMode;
   anEditor.phobosDocRoot:=fPhobosDocRoot;
   anEditor.alwaysAdvancedFeatures:=fAlwaysAdvancedFeatures;
+  anEditor.smartDdocNewline:= fSmartDdocNewline;
   for i := 0 to anEditor.Keystrokes.Count-1 do
   begin
     kst := anEditor.Keystrokes.Items[i];

src/ce_synmemo.pas

@@ -168,6 +168,7 @@ type
     fCallTipStrings: TStringList;
     fOverrideColMode: boolean;
     fAutoCloseCurlyBrace: TBraceAutoCloseStyle;
+    fSmartDdocNewline: boolean;
     fLexToks: TLexTokenList;
     fDisableFileDateCheck: boolean;
     fDetectIndentMode: boolean;
@@ -203,6 +204,7 @@ type
       var SourceStart, SourceEnd: TPoint; KeyChar: TUTF8Char; Shift: TShiftState);
     procedure showCallTips(const tips: string);
     function lexCanCloseBrace: boolean;
+    function lexInDdoc: char;
     procedure handleStatusChanged(Sender: TObject; Changes: TSynStatusChanges);
     procedure gotoToChangedArea(next: boolean);
     procedure gotoToProtectionGroup(next: boolean);
@@ -255,6 +257,7 @@ type
     procedure saveTempFile;
     //
     procedure curlyBraceCloseAndIndent;
+    procedure insertLeadingDDocSymbol(c: char);
     procedure commentSelection;
     procedure commentIdentifier;
     procedure renameIdentifier;
@@ -301,6 +304,7 @@ type
     property autoDotDelay: Integer read fAutoDotDelay write setAutoDotDelay;
     property autoCloseCurlyBrace: TBraceAutoCloseStyle read fAutoCloseCurlyBrace write fAutoCloseCurlyBrace;
     property autoClosedPairs: TAutoClosePairs read fAutoClosedPairs write fAutoClosedPairs;
+    property smartDdocNewline: boolean read fSmartDdocNewline write fSmartDdocNewline;
   end;
 
   TSortDialog = class(TForm)
@@ -697,6 +701,7 @@ begin
   Font.Size:=10;
   SetDefaultCoeditKeystrokes(Self); // not called in inherited if owner = nil !
   fLexToks:= TLexTokenList.Create;
+  fSmartDdocNewline := true;
 
   OnDragDrop:= @ddHandler.DragDrop;
   OnDragOver:= @ddHandler.DragOver;
@@ -1135,6 +1140,15 @@ begin
   end;
 end;
 
+procedure TCESynMemo.insertLeadingDDocSymbol(c: char);
+begin
+  BeginUndoBlock;
+  if ((CaretX-1) and 1) = 0 then
+    ExecuteCommand(ecChar, ' ', nil);
+  ExecuteCommand(ecChar, c, nil);
+  EndUndoBlock;
+end;
+
 procedure TCESynMemo.curlyBraceCloseAndIndent;
 var
   i: integer;
@@ -2131,6 +2145,8 @@ procedure TCESynMemo.handleStatusChanged(Sender: TObject; Changes: TSynStatusCha
 begin
   if scOptions in Changes then
   begin
+    if fSmartDdocNewline and not (eoAutoIndent in Options) then
+      Options := Options + [eoAutoIndent];
     if Beautifier.isNotNil and (Beautifier is TSynBeautifier) then
     begin
       if not (eoTabsToSpaces in Options) and not (eoSpacesToTabs in Options) then
@@ -2181,6 +2197,32 @@ begin
   end;
 end;
 
+function TCESynMemo.lexInDdoc: char;
+var
+  i: integer;
+  p: integer;
+  tk1: PLexToken = nil;
+  tk2: PLexToken = nil;
+begin
+  result := #0;
+  p := SelStart;
+  for i := 0 to fLexToks.Count-1 do
+  begin
+    tk1 := fLexToks[i];
+    if (i <> fLexToks.Count-1) then
+    begin
+      tk2 := fLexToks[i+1];
+      if (tk1^.offset < p) and (tk1^.kind in [ltkComment, ltkIllegal])
+        and (tk2^.offset > p) then
+          exit(tk1^.Data[1])
+      else if (tk1^.offset > p) then
+        exit;
+    end
+    else if (tk1^.offset < p) and (tk1^.kind in [ltkComment, ltkIllegal]) then
+      exit(tk1^.Data[1]);
+  end;
+end;
+
 function TCESynMemo.lexCanCloseBrace: boolean;
 var
   i: integer;
@@ -2502,6 +2544,7 @@ end;
 procedure TCESynMemo.KeyDown(var Key: Word; Shift: TShiftState);
 var
   line: string;
+  ddc: char;
 begin
   case Key of
     VK_BACK: if fCallTipWin.Visible and (CaretX > 1)
@@ -2510,7 +2553,7 @@ begin
     VK_RETURN:
     begin
       line := LineText;
-      if (fAutoCloseCurlyBrace in [autoCloseOnNewLineEof .. autoCloseOnNewLineLexically]) then
+
       case fAutoCloseCurlyBrace of
         autoCloseOnNewLineAlways: if (CaretX > 1) and (line[LogicalCaretXY.X - 1] = '{') then
         begin
@@ -2523,17 +2566,34 @@ begin
           Key := 0;
           curlyBraceCloseAndIndent;
         end;
-        autoCloseOnNewLineLexically: if (LogicalCaretXY.X - 1 >= line.length)
-            or isBlank(line[LogicalCaretXY.X .. line.length]) then
+      end;
+
+      if (fAutoCloseCurlyBrace = autoCloseOnNewLineLexically) or
+        fSmartDdocNewline then
       begin
         fLexToks.Clear;
         lex(lines.Text, fLexToks);
+        if (LogicalCaretXY.X - 1 >= line.length)
+            or isBlank(line[LogicalCaretXY.X .. line.length]) then
+        begin
           if lexCanCloseBrace then
           begin
             Key := 0;
             curlyBraceCloseAndIndent;
           end;
         end;
+        if (fSmartDdocNewline) then
+        begin
+          ddc := lexInDdoc;
+          if ddc in ['*', '+'] then
+          begin
+            inherited;
+            insertLeadingDDocSymbol(ddc);
+            fCanShowHint:=false;
+            fDDocWin.Hide;
+            exit;
+          end;
+        end;
       end;
     end;
   end;