com.rtfparserkit.parser.standard.UprHandler Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of mpxj Show documentation

Library that provides facilities to allow project information to be manipulated in Java and .Net. Supports a range of data formats: Microsoft Project Exchange (MPX), Microsoft Project (MPP,MPT), Microsoft Project Data Interchange (MSPDI XML), Microsoft Project Database (MPD), Planner (XML), Primavera (PM XML, XER, and database), Asta Powerproject (PP, MDB), Asta Easyplan (PP), Phoenix Project Manager (PPX), FastTrack Schedule (FTS), and the Standard Data Exchange Format (SDEF).

There is a newer version: 13.8.0

Show newest version

/*
 * Copyright 2013 Jon Iles
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * 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.
 */

package com.rtfparserkit.parser.standard;

import java.util.ArrayList;
import java.util.List;

import com.rtfparserkit.rtf.Command;

/**
 * The upr command is used to wrap two different versions of the same set of
 * formatting commands. The first set of formatting commands uses ANSI encoding,
 * the second set uses Unicode. The upr command is expected to appear
 * in its own group, so this handler can be used to consume all of the RTF events
 * received up to the end of the group It can then pass the Unicode version of
 * the command it wraps to the listener, discarding the ANSI version.
 */
public class UprHandler implements IParserEventHandler
{
   /**
    * Constructor.
    */
   public UprHandler(IParserEventHandler handler)
   {
      this.handler = handler;
   }

   /**
    * Buffers events until the end of the group containing the upr command is reached.
    * Once the end of the group is reached, the buffered events representing the
    * Unicode content is sent to the listener. 
    */
   @Override
   public void handleEvent(IParserEvent event)
   {
      events.add(event);
      switch (event.getType())
      {
         case GROUP_START_EVENT:
         {
            ++groupCount;
            break;
         }

         case GROUP_END_EVENT:
         {
            --groupCount;
            break;
         }

         default:
            break;
      }

      if (groupCount == 0)
      {
         processCommands();
      }
   }

   /**
    * Retrieve the last event seen by the handler.
    */
   @Override
   public IParserEvent getLastEvent()
   {
      return events.get(events.size() - 1);
   }

   /**
    * Assumes the handler is buffering events, and removes the last event from this buffer.
    */
   @Override
   public void removeLastEvent()
   {
      events.remove(events.size() - 1);
   }

   /**
    * Returns true once the end of the group containing the upr command as been reached.
    */
   @Override
   public boolean isComplete()
   {
      return complete;
   }

   /**
    * Extracts the Unicode version of the commands wrapped by the upr
    * command and passes them to the listener. 
    */
   private void processCommands()
   {
      int index = 0;
      while (true)
      {
         if (index == events.size())
         {
            throw new RuntimeException("UPR command: structure not recognised");
         }
         IParserEvent event = events.get(index);
         if (event.getType() == ParserEventType.COMMAND_EVENT)
         {
            CommandEvent command = (CommandEvent) event;
            if (command.getCommand() == Command.ud)
            {
               break;
            }
         }
         ++index;
      }

      if (index == events.size())
      {
         throw new RuntimeException("UPR command: structure not recognised: unable to locate UD command");
      }

      ++index;
      if (events.get(index).getType() != ParserEventType.GROUP_START_EVENT)
      {
         throw new RuntimeException("UPR command: expecting group start, found: " + events.get(index).getType());
      }

      ++index;
      int endIndex = index;
      int groupCount = 1;
      while (true)
      {
         if (endIndex == events.size())
         {
            break;
         }

         IParserEvent event = events.get(endIndex);
         switch (event.getType())
         {
            case GROUP_START_EVENT:
            {
               ++groupCount;
               break;
            }

            case GROUP_END_EVENT:
            {
               --groupCount;
               break;
            }

            default:
               break;
         }

         if (groupCount == 0)
         {
            break;
         }
         ++endIndex;
      }

      if (index == events.size())
      {
         throw new RuntimeException("UPR command: structure not recognised: unable to locate UD group end");
      }

      while (index <= endIndex)
      {
         handler.handleEvent(events.get(index));
         ++index;
      }

      complete = true;
   }

   private final IParserEventHandler handler;
   private int groupCount = 1;
   private boolean complete;
   private final List events = new ArrayList();
}