/*
    Copyright (C) 2013-2023 Nicola L.C. Talbot
    www.dickimaw-books.com

    This program 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.

    This program 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 this program; if not, write to the Free Software
    Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
*/
package com.dickimawbooks.texparserlib;

import java.io.IOException;

public class SpChar extends Macro implements SingleToken
{
   public SpChar(int charCode)
   {
      this.charCode = charCode;
   }

   public SpChar()
   {
      this('^');
   }

   public SpChar(TeXParser parser)
   {
      this(parser.getSpChar());
   }

   @Override
   public int getCharCode()
   {
      return charCode;
   }

   @Override
   public int getCatCode()
   {
      return TeXParser.TYPE_SP;
   }

   @Override
   public Object clone()
   {
      return new SpChar(charCode);
   }

   @Override
   public String format()
   {
      return new String(Character.toChars(charCode));
   }

   @Override
   public String toString(TeXParser parser)
   {
      return format();
   }

   @Override
   public TeXObjectList string(TeXParser parser)
     throws IOException
   {
      TeXObjectList list = new TeXObjectList();
      list.add(parser.getListener().getOther(charCode));

      return list;
   }

   @Override
   public void process(TeXParser parser, TeXObjectList stack)
     throws IOException
   {
      TeXObject object = stack.popArg(parser);

      TeXObject nextObject = stack.peekStack();

      if (nextObject instanceof SpChar)
      {
         stack.push(parser.getListener().createGroup());

         parser.error(new TeXSyntaxException(
           parser, TeXSyntaxException.ERROR_DOUBLE_SUPERSCRIPT, 
               object.toString(parser)));
      }

      parser.getListener().superscript(object);
   }

   @Override
   public void process(TeXParser parser)
     throws IOException
   {
      TeXObject object = parser.popNextArg();

      TeXObject nextObject = parser.peekStack();

      if (nextObject instanceof SpChar)
      {
         parser.push(parser.getListener().createGroup());

         parser.error(new TeXSyntaxException(
           parser, TeXSyntaxException.ERROR_DOUBLE_SUPERSCRIPT, 
               object.toString(parser)));
      }

      parser.getListener().superscript(object);
   }

   public String show(TeXParser parser)
    throws IOException
   {
      return String.format("superscript character %s", format());
   }

   protected int charCode;
}

