code.ts

/** Admonitions to visualise programming codes */
import type Token from "markdown-it/lib/token"
import { Directive, IDirectiveData } from "./main"
import {
  class_option,
  flag,
  int,
  optional_int,
  unchanged,
  unchanged_required
} from "./options"

// TODO add Highlight directive

/** Mark up content of a code block
 *
 * Adapted from sphinx/directives/patches.py
 */
export class Code extends Directive {
  public required_arguments = 0
  public optional_arguments = 1
  public final_argument_whitespace = false
  public has_content = true
  public option_spec = {
    /** Add line numbers, optionally starting from a particular number. */
    "number-lines": optional_int,
    /** Ignore minor errors on highlighting */
    force: flag,
    name: unchanged,
    class: class_option
  }
  run(data: IDirectiveData<keyof Code["option_spec"]>): Token[] {
    // TODO handle options
    this.assert_has_content(data)
    const token = this.createToken("fence", "code", 0, {
      // TODO if not specified, the language should come from a central configuration "highlight_language"
      info: data.args ? data.args[0] : "",
      content: data.body,
      map: data.bodyMap
    })
    if (data.options["number-lines"]) {
      token.attrSet("number-lines", data.options["number-lines"])
    }
    if (data.options.force) {
      token.attrSet("force", data.options.force)
    }
    if (data.options.name) {
      token.attrSet("name", data.options.name)
    }
    if (data.options.class) {
      token.attrJoin("class", data.options.class.join(" "))
    }
    return [token]
  }
}

/** Mark up content of a code block, with more settings
 *
 * Adapted from sphinx/directives/code.py
 */
export class CodeBlock extends Directive {
  public required_arguments = 0
  public optional_arguments = 1
  public final_argument_whitespace = false
  public has_content = true
  public option_spec = {
    /** Add line numbers. */
    linenos: flag,
    /** Start line numbering from a particular value. */
    "lineno-start": int,
    /** Strip indentation characters from the code block.
     * When number given, leading N characters are removed
     */
    dedent: optional_int,
    /** Emphasize particular lines (comma-separated numbers) */
    "emphasize-lines": unchanged_required,
    caption: unchanged_required,
    /** Ignore minor errors on highlighting */
    force: flag,
    name: unchanged,
    class: class_option
  }
  run(data: IDirectiveData<keyof CodeBlock["option_spec"]>): Token[] {
    // TODO handle options
    this.assert_has_content(data)
    const token = this.createToken("fence", "code", 0, {
      // TODO if not specified, the language should come from a central configuration "highlight_language"
      info: data.args ? data.args[0] : "",
      content: data.body,
      map: data.bodyMap
    })
    if (data.options.linenos === null) {
      token.attrSet("linenos", "true")
    }
    if (data.options["lineno-start"]) {
      token.attrSet("lineno-start", data.options["lineno-start"])
    }
    if (data.options.dedent) {
      token.attrSet("dedent", data.options.dedent)
    }
    if (data.options["emphasize-lines"]) {
      token.attrSet("emphasize-lines", data.options["emphasize-lines"])
    }
    if (data.options.caption) {
      token.attrSet("caption", data.options.caption)
    }
    if (data.options.force) {
      token.attrSet("force", data.options.force)
    }
    if (data.options.name) {
      token.attrSet("name", data.options.name)
    }
    if (data.options.class) {
      token.attrJoin("class", data.options.class.join(" "))
    }

    return [token]
  }
}

/** A code cell is a special MyST based cell, signifying executable code. */
export class CodeCell extends Directive {
  public required_arguments = 0
  public optional_arguments = 1
  public final_argument_whitespace = false
  public has_content = true
  public rawOptions = true

  run(data: IDirectiveData<keyof CodeCell["option_spec"]>): Token[] {
    // TODO store options and the fact that this is a code cell rather than a fence?
    const token = this.createToken("fence", "code", 0, {
      info: data.args ? data.args[0] : "",
      content: data.body,
      map: data.bodyMap
    })
    return [token]
  }
}

export const code = {
  code: Code,
  "code-block": CodeBlock,
  "code-cell": CodeCell
}