Added initial support to CommonMark.

Support for Strike, Ins, Mark and Sub tags.
Rewrite of Dialect selection.
Bug fixes.

Signed-off-by: Miguel A. Risco-Castillo

Author: mriscoc

README.md

@@ -15,12 +15,16 @@ At present the following dialects of markdown are supported:
 * Enhanced TxtMark dialect
  (translated from <https://github.com/rjeschke/txtmark>)
 
+* Initial support for CommonMark dialect
+ (translated from <http://commonmark.org/>)
+
 Wishlist: PEGDown (Github dialect), CommonMark, etc.
 
 All you need to use the library is FPC version 3.0.4 or newer.
 
-## Using the Library
 
+Using the Library
+-----------------
 
 Declare a variable of the class TMarkdownProcessor:
 
@@ -35,20 +39,25 @@ Decide whether you want to allow active content
 
        md.UnSafe := true;
 
-Note: you should only set this to true if you *need* to - active content can be a signficant safety/security issue.  
+Note: you should only set this to true if you *need* to - active content can be a significant safety/security issue.  
 
 Generate HTML fragments from Markdown content:
 
        html := md.process(markdown); 
 
 Note that the HTML returned is an HTML fragment, not a full HTML page.  
 
-Do not forget to dispose the object after the use:
+Do not forget to dispose of the object after the use:
 
        md.free
 
-## License
+Examples
+--------
+The demo folder contains two demonstrative [Lazarus](http://www.lazarus-ide.org/) programs,
+the most advanced, `MarkdownHTML`, needs the [HTMLViewer](https://github.com/BerndGabriel/HtmlViewer) control.
 
+License
+-------
 Copyright (C) Miguel A. Risco-Castillo
 
 FPC-markdown implementation is a fork of Grahame Grieve pascal port

demos/MarkDownHtml/MarkDownHtml.lpi

@@ -11,9 +11,19 @@
       <UseXPManifest Value="True"/>
       <XPManifest>
         <DpiAware Value="True"/>
+        <TextName Value="uEGroup.FPCMarkDown.TestHtmlConveter"/>
+        <TextDesc Value="Test Markdown Processor for FPC."/>
       </XPManifest>
       <Icon Value="0"/>
     </General>
+    <VersionInfo>
+      <UseVersionInfo Value="True"/>
+      <MinorVersionNr Value="2"/>
+      <RevisionNr Value="3"/>
+      <BuildNr Value="18"/>
+      <Attributes pvaPreRelease="True"/>
+      <StringTable ProductVersion="0.0.0.0"/>
+    </VersionInfo>
     <BuildModes Count="3">
       <Item1 Name="Default" Default="True"/>
       <Item2 Name="Debug">
@@ -142,4 +152,17 @@
       <CustomOptions Value="-dBorland -dVer150 -dDelphi7 -dCompiler6_Up -dPUREPASCAL"/>
     </Other>
   </CompilerOptions>
+  <Debugging>
+    <Exceptions Count="3">
+      <Item1>
+        <Name Value="EAbort"/>
+      </Item1>
+      <Item2>
+        <Name Value="ECodetoolError"/>
+      </Item2>
+      <Item3>
+        <Name Value="EFOpenError"/>
+      </Item3>
+    </Exceptions>
+  </Debugging>
 </CONFIG>

demos/MarkDownHtml/MarkDownHtmlu.lfm

@@ -1,7 +1,7 @@
 object MainForm: TMainForm
-  Left = 945
+  Left = 1041
   Height = 499
-  Top = 273
+  Top = 340
   Width = 790
   Caption = 'Test MarkDown Convertion'
   ClientHeight = 499
@@ -547,7 +547,7 @@ object MainForm: TMainForm
           'Basic Information'
           '-----------------'
           ''
-          'This is a Pascal (`FPC`) library that processes markdown to HTML.'
+          'This is a Pascal (FPC) library that processes markdown to HTML.'
           'At present the following dialects of markdown are supported:'
           ''
           '* The Daring Fireball dialect'
@@ -556,6 +556,9 @@ object MainForm: TMainForm
           '* Enhanced TxtMark dialect'
           ' (translated from <https://github.com/rjeschke/txtmark>)'
           ''
+          '* Initial support for CommonMark dialect'
+          ' (translated from <http://commonmark.org/>)'
+          ''
           'Wishlist: PEGDown (Github dialect), CommonMark, etc.'
           ''
           'All you need to use the library is FPC version 3.0.4 or newer.'
@@ -576,15 +579,15 @@ object MainForm: TMainForm
           ''
           '       md.UnSafe := true;'
           '  '
-          'Note: you should only set this to true if you *need* to - active content can be a signficant safety/security issue.  '
+          'Note: you should only set this to true if you *need* to - active content can be a significant safety/security issue.  '
           ' '
           'Generate HTML fragments from Markdown content:'
           ''
           '       html := md.process(markdown); '
           '  '
           'Note that the HTML returned is an HTML fragment, not a full HTML page.  '
           '  '
-          'Do not forget to dispose the object after the use:'
+          'Do not forget to dispose of the object after the use:'
           ''
           '       md.free'
           ''
@@ -629,6 +632,7 @@ object MainForm: TMainForm
         MouseLinkColor.Foreground = clBlue
         LineHighlightColor.Background = clCream
         LineHighlightColor.Foreground = clNone
+        TabWidth = 4
         inline SynLeftGutterPartList1: TSynGutterPartList
           object SynGutterMarks1: TSynGutterMarks
             Width = 24

demos/MarkDownHtml/MarkDownHtmlu.pas

@@ -6,8 +6,8 @@ interface
 
 uses
   Classes, SysUtils, LazFileUtils, SynEdit, SynHighlighterHTML, Forms, Controls,
-  Graphics, Dialogs, StdCtrls, ExtCtrls, Clipbrd, MarkdownProcessor, LCLIntf,
-  ComCtrls, Buttons, StrUtils, HtmlView, HtmlGlobals, HTMLUn2;
+  Graphics, Dialogs, StdCtrls, ExtCtrls, Clipbrd, MarkdownProcessor, MarkdownUtils,
+  LCLIntf, ComCtrls, Buttons, StrUtils, HtmlView, HtmlGlobals, HTMLUn2;
 
 type
 
@@ -140,7 +140,7 @@ procedure TMainForm.FormCreate(Sender: TObject);
 var
   i:integer;
 begin
-  md := TMarkdownProcessor.createDialect(mdTxtMark);
+  md := TMarkdownProcessor.createDialect(mdCommonMark);
   md.UnSafe := false;
   RootPath:=GetTempDir;
   I:=0;

fpc_markdown.lpk

@@ -54,7 +54,7 @@ distributed under the License is distributed on an "AS IS" BASIS,
 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 See the License for the specific language governing permissions and
 limitations under the License."/>
-    <Version Major="1" Release="1"/>
+    <Version Major="1" Minor="1" Release="1" Build="3"/>
     <Files Count="5">
       <Item1>
         <Filename Value="source\MarkdownProcessor.pas"/>
@@ -66,7 +66,7 @@ limitations under the License."/>
       </Item2>
       <Item3>
         <Filename Value="source\markdowntxtmark.pas"/>
-        <UnitName Value="markdowntxtmark"/>
+        <UnitName Value="MarkdownTxtMark"/>
       </Item3>
       <Item4>
         <Filename Value="source\MarkdownUtils.pas"/>

source/MarkdownCommonMark.pas

@@ -46,11 +46,11 @@ implementation
 constructor TMarkdownCommonMark.Create;
 begin
   inherited;
+  Config.Dialect:=mdCommonMark;
 end;
 
 destructor TMarkdownCommonMark.Destroy;
 begin
-
   inherited;
 end;
 

source/MarkdownDaringFireball.pas

@@ -27,27 +27,24 @@ interface
   SysUtils, Classes, TypInfo,
   MarkdownProcessor, MarkdownUtils;
 
-
 type
 
   TMarkdownDaringFireball = class(TMarkdownProcessor)
   private
-    FConfig: TConfiguration;
+//    Config: TConfiguration;
     Femitter: TEmitter;
     FuseExtensions: boolean;
     function readLines(reader : TReader): TBlock;
     procedure initListBlock(root: TBlock);
     procedure recurse(root: TBlock; listMode: boolean);
-
   protected
     function GetUnSafe: boolean; override;
     procedure SetUnSafe(const value: boolean); override;
   public
     Constructor Create;
     Destructor Destroy; override;
     function process(source: String): String; override;
-    property config: TConfiguration read FConfig;
-
+//    property config: TConfiguration read Config;
   end;
 
 implementation
@@ -57,20 +54,20 @@ implementation
 constructor TMarkdownDaringFireball.Create;
 begin
   inherited Create;
-  FConfig := TConfiguration.Create(true);
+  Config := TConfiguration.Create(true);
   Femitter := TEmitter.Create(config);
 end;
 
 destructor TMarkdownDaringFireball.Destroy;
 begin
-  FConfig.Free;
+  Config.Free;
   Femitter.Free;
   inherited;
 end;
 
 function TMarkdownDaringFireball.GetUnSafe: boolean;
 begin
-  result := not FConfig.safeMode;
+  result := not Config.safeMode;
 end;
 
 procedure TMarkdownDaringFireball.initListBlock(root: TBlock);
@@ -82,7 +79,7 @@ procedure TMarkdownDaringFireball.initListBlock(root: TBlock);
   line := line.next;
   while (line <> nil) do
   begin
-    t := line.getLineType(FConfig);
+    t := line.getLineType(Config);
     if ((t = ltOLIST) or (t = ltULIST) or (not line.isEmpty and (line.prevEmpty and (line.leading = 0) and not((t = ltOLIST) or (t = ltULIST))))) then
       root.split(line.previous).type_ := btLIST_ITEM;
     line := line.next;
@@ -96,8 +93,7 @@ function TMarkdownDaringFireball.process(source: String): String;
   parent, block: TBlock;
   rdr : TReader;
 begin
-  FuseExtensions := config.forceExtendedProfile;
-  Femitter.FuseExtensions:=config.forceExtendedProfile;
+  FuseExtensions := Config.isDialect([mdTxtMark,mdCommonMark]);
   rdr := TReader.Create(source);
   try
     out_ := TStringBuilder.Create;
@@ -175,7 +171,7 @@ function TMarkdownDaringFireball.readLines(reader : TReader): TBlock;
               c := reader.read();
             end;
         else
-          if (c <> '<') or (not FConfig.panicMode) then
+          if (c <> '<') or (not Config.panicMode) then
           begin
             inc(position);
             sb.append(c);
@@ -259,8 +255,7 @@ function TMarkdownDaringFireball.readLines(reader : TReader): TBlock;
             if LowerCase(link) = 'extended' then
             begin
               FuseExtensions:=true;
-              Config.forceExtendedProfile:=true;
-              Femitter.FuseExtensions := true;
+              Config.Dialect:=mdTxtMark;
             end;
             lastLinkRef := nil;
           end
@@ -324,8 +319,8 @@ procedure TMarkdownDaringFireball.recurse(root: TBlock; listMode: boolean);
   line := root.lines;
   if (listMode) then
   begin
-    root.removeListIndent(FConfig);
-    if (FuseExtensions and (root.lines <> nil) and (root.lines.getLineType(FConfig) <> ltCODE)) then
+    root.removeListIndent(Config);
+    if (Config.isDialect([mdTxtMark]) and (root.lines <> nil) and (root.lines.getLineType(Config) <> ltCODE)) then
       root.id := root.lines.stripID();
   end;
 
@@ -336,14 +331,14 @@ procedure TMarkdownDaringFireball.recurse(root: TBlock; listMode: boolean);
 
   while (line <> nil) do
   begin
-    type_ := line.getLineType(FConfig);
+    type_ := line.getLineType(Config);
     case type_ of
       ltOTHER:
         begin
           wasEmpty := line.prevEmpty;
           while (line <> nil) and (not line.isEmpty) do
           begin
-            t := line.getLineType(FConfig);
+            t := line.getLineType(Config);
             if (listMode or FuseExtensions) and (t in [ltOLIST, ltULIST]) then
               break;
             if (FuseExtensions and (t in [ltCODE, ltFENCED_CODE])) then
@@ -403,7 +398,7 @@ procedure TMarkdownDaringFireball.recurse(root: TBlock; listMode: boolean);
         begin
           while (line <> nil) do
           begin
-            if (not line.isEmpty and (line.prevEmpty and (line.leading = 0) and (line.getLineType(FConfig) <> ltBQUOTE))) then
+            if (not line.isEmpty and (line.prevEmpty and (line.leading = 0) and (line.getLineType(Config) <> ltBQUOTE))) then
               break;
             line := line.next;
           end;
@@ -431,7 +426,7 @@ procedure TMarkdownDaringFireball.recurse(root: TBlock; listMode: boolean);
           line := line.next;
           while (line <> nil) do
           begin
-            if (line.getLineType(FConfig) = ltFENCED_CODE) then
+            if (line.getLineType(Config) = ltFENCED_CODE) then
               break;
             // TODO ... is this really necessary? Maybe add a special flag?
             line := line.next;
@@ -446,7 +441,7 @@ procedure TMarkdownDaringFireball.recurse(root: TBlock; listMode: boolean);
           block.type_ := btFENCED_CODE;
           block.meta := TUtils.getMetaFromFence(block.lines.value);
           block.lines.setEmpty();
-          if (block.lineTail.getLineType(FConfig) = ltFENCED_CODE) then
+          if (block.lineTail.getLineType(Config) = ltFENCED_CODE) then
             block.lineTail.setEmpty();
           block.removeSurroundingEmptyLines();
         end;
@@ -463,7 +458,7 @@ procedure TMarkdownDaringFireball.recurse(root: TBlock; listMode: boolean);
               block.hlDepth := 1
             else
               block.hlDepth := 2;
-          if (FuseExtensions) then
+          if Config.isDialect([mdTxtMark]) then
             block.id := block.lines.stripID();
           block.transfromHeadline();
           root.removeLeadingEmptyLines();
@@ -473,7 +468,7 @@ procedure TMarkdownDaringFireball.recurse(root: TBlock; listMode: boolean);
         begin
           while (line <> nil) do
           begin
-            t := line.getLineType(FConfig);
+            t := line.getLineType(Config);
             if (not line.isEmpty and (line.prevEmpty and (line.leading = 0) and (not(t = type_)))) then
               break;
             line := line.next;
@@ -508,7 +503,7 @@ procedure TMarkdownDaringFireball.recurse(root: TBlock; listMode: boolean);
 
 procedure TMarkdownDaringFireball.SetUnSafe(const value: boolean);
 begin
-  FConfig.safeMode := not value;
+  Config.safeMode := not value;
 end;
 
 end.