Merge pull request #3 from kn1cht/feature/figure-environment

Support figure environment

src/latex-to-ast/environment/common.ts

@@ -44,11 +44,12 @@ export const BeginEnvironment = (
 
 export const EndEnvironment = (context: Context): Parsimmon.Parser<null> =>
   Parsimmon((input, i) => {
-    const m = input.slice(i).match(new RegExp(`^\\\\end\\{${context.name}\\}`));
+    const p = context.name.replace(/[\\^$.*+?()[\]{}|]/g, '\\$&');
+    const m = input.slice(i).match(new RegExp(`^\\\\end\\{${p}\\}`));
     if (m !== null) {
       return Parsimmon.makeSuccess(i + m[0].length, null);
     } else {
-      return Parsimmon.makeFailure(i, `\\end{${context.name}}`);
+      return Parsimmon.makeFailure(i, `\\end{${p}}`);
     }
   });
 

src/latex-to-ast/environment/figure.ts

@@ -0,0 +1,40 @@
+/*
+ * This file is part of textlint-plugin-latex2e
+ *
+ * Foobar is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * Foobar is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with Foobar.  If not, see <http://www.gnu.org/licenses/>.
+ */
+
+import Parsimmon from "parsimmon";
+import { Rules } from "../rules";
+import { BeginEnvironment, EndEnvironment, EnvironmentNode } from "./common";
+
+export const Figure = (r: Rules) => {
+  const context = { name: "" };
+  const body = Parsimmon.seqMap(
+    Parsimmon.index,
+    Parsimmon.index,
+    (start, end) => ({
+      start,
+      end,
+      name: "figure"
+    })
+  );
+  return Parsimmon.seqObj<EnvironmentNode>(
+    ["name", BeginEnvironment("figure\\\*?", context)],
+    ["arguments", Parsimmon.alt(r.Option, r.Argument).many()],
+    Parsimmon.whitespace,
+    ["body", body],
+    EndEnvironment(context)
+  ).node("environment");
+};

src/latex-to-ast/environment/index.ts

@@ -16,6 +16,7 @@
  */
 export { DisplayMath } from "./displaymath";
 export { Environment } from "./common";
+export { Figure } from "./figure";
 export { InlineMath } from "./inlinemath";
 export { Document } from "./document";
 export { List } from "./list";

src/latex-to-ast/index.ts

@@ -167,6 +167,13 @@ export const parse = (text: string) => {
                 children: node.value.arguments.concat(node.value.body)
               });
               break;
+            case "figure":
+              this.update({
+                ...tmp,
+                type: ASTNodeTypes.Image,
+                children: node.value.arguments.concat(node.value.body)
+              });
+              break;
             default:
               this.update({
                 ...tmp,

src/latex-to-ast/latex.ts

@@ -19,6 +19,7 @@ import Parsimmon from "parsimmon";
 import {
   Environment,
   DisplayMath,
+  Figure,
   InlineMath,
   Document,
   List
@@ -35,6 +36,7 @@ export const LaTeX = Parsimmon.createLanguage({
   Document,
   List,
   DisplayMath,
+  Figure,
   InlineMath,
   Command,
   Verbatim,

test/latex-to-ast.test.ts

@@ -76,6 +76,19 @@ describe("Parsimmon AST", async () => {
     const ast = LaTeX.Program.tryParse(code);
     expect(ast.value[0].value.body.value.length).toBe(2);
   });
+  test("figure environment", async () => {
+    const code = `\\begin{figure}
+        \\includegraphics[width=5cm]{somefigure.png}
+        \\caption{This is a caption}
+        \\end{figure}
+        \\begin{figure*}
+        \\includegraphics[width=5cm]{anotherfigure.png}
+        \\caption{This is an another caption}
+        \\end{figure*}`;
+    const ast = LaTeX.Program.tryParse(code);
+    expect(ast.value[0].value.name).toBe("figure");
+    expect(ast.value[2].value.name).toBe("figure*");
+  });
 });
 
 describe("TxtNode AST", async () => {