package Breccia.parser.plain;

import Breccia.parser.ParseError;
import Java.CharacterPointer;


public class MalformedText extends ParseError {


    /** @see #pointer
      * @see #getMessage()
      */
    MalformedText( final CharacterPointer pointer, final String message ) {
        super( pointer.lineNumber, message + '\n' + pointer.markedLine() );
        this.pointer = pointer; }



    /** @see #pointer
      */
    static MalformedText misplacedNoBreakSpace( final CharacterPointer pointer ) {
        return new MalformedText( pointer, "Misplaced no-break space (Unicode 00A0)" ); }



    /** Indicant of where precisely the ill form was detected.
      */
    public final CharacterPointer pointer;



    /** @see #pointer
      */
    static MalformedText spaceExpected( final CharacterPointer pointer ) {
        return new MalformedText( pointer, "Plain space expected (Unicode 0020)" ); }



    /** @see #pointer
      */
    static MalformedText termExpected( final CharacterPointer pointer ) {
        return new MalformedText( pointer, "Term expected" ); }



    /** @see #pointer
      * @param ch The character that implies the newline that never gets completed.
      */
    static MalformedText truncatedNewline( final CharacterPointer pointer, final char ch ) {
        assert ch == '\r'; // For sake of an intelligible error message; see `Language.impliesNewline`.
        return new MalformedText( pointer,
          "Truncated newline: Carriage return (Unicode 000D) without line feed successor (000A)" ); }



    /** @see #pointer
      */
    static MalformedText truncatedPattern( final CharacterPointer pointer ) {
        return new MalformedText( pointer, "Truncated pattern" ); }



    /** @see #pointer
      */
    static MalformedText unexpectedTerm( final CharacterPointer pointer ) {
        return new MalformedText( pointer, "Unexpected term" ); }}



                                                   // Copyright © 2021-2022  Michael Allan.  Licence MIT.