Merge branch 'fix/github-issue-bug7' into release/alpha/master

Author: coderarjob

README.md

@@ -46,13 +46,20 @@ Here is the rough roadmap of the development.
 
 ----
 
+- [X] Bug Fixes: Some minor fixes in UI
+- [X] Feature: Added new parser for reading older Kindle Clippings format.
+- [X] UI change to select different parsers.
+- [ ] **Alpha Release 4**
+
+----
+
 - [ ] Fine tune the rough edges in the supporting library.
 - [ ] Memory/Resource optimization.
 - [ ] Finalizing and optimizing the Graphical User Interface.
 - [ ] **Beta Release**
 
 ## Requirements
-- JRE 1.8 or higher
+- JRE 1.8 or higher __Note: JRE headless will not work.__
 - Linux, Windows
 - Mac OS
 

build.sh

@@ -63,7 +63,7 @@ cp -r src/coderarjob/kpdfsync/poc/res $BIN_DIR/coderarjob/kpdfsync/poc || exit
 # -----------------------------------------------------------------------------
 # Replace placeholder information in resource files.
 # -----------------------------------------------------------------------------
-VER=0.9.0
+VER=0.10.0
 TAG=alpha
 buildid=$(date +%y%m%d)
 

docs/images/screenshot_alpha.png

@@ -11,28 +11,23 @@
 
 public abstract class AbstractParser
 {
-  protected enum ParsingErrors
-  {
-    NO_ERROR, END_OF_BLOCK_REACHED, PARSING_ERROR;
-
-    private String mTag;
-    public void setTag (String name) { this.mTag = name; }
-    public String getTag()           { return this.mTag; }
-
-  }
-
   /* Abstract public methods */
-  public abstract boolean       moveToNextEntry()                            throws Exception;
-  public abstract void          moveToEntryAtOffset (long offset)            throws Exception;
-  public abstract ParsingErrors parseLine(int linei, ParserResult result)    throws Exception;
   public abstract String        getParserVersion();
   public abstract String[]      getSupportedKindleVersions();
 
+  /* Abstract protected methods */
+  protected abstract boolean isTerminationLine (String linestr);
+  protected abstract boolean parseLine(int linei, ParserResult res) throws Exception;
+
   /* Protected fields */
   protected String           mFileName;
   protected RandomAccessFile mFile;
   protected Charset          mCharset;
   protected ParserEvents     mParserEvents;
+  protected boolean mIsInvalidState;         /* On paring error, this is set to true.
+                                                False indicates, no error, or file pointer has
+                                                moved to the next block after the previous parsing
+                                                error.*/
 
   /* Private fields */
   private long   mLastFilePointer;
@@ -47,7 +42,11 @@ protected enum ParsingErrors
   public    void         setParserEvents (ParserEvents value) { this.mParserEvents = value; }
 
   /* Hook methods */
-  protected void onParsingStart() throws Exception { }
+  protected void onParsingStart() throws Exception
+  {
+    if (this.mIsInvalidState)
+      throw new ParserException ("Invalid parser state : On an invalid line.");
+  }
 
   protected void onParsingSuccess (ParserResult result) throws Exception
   {
@@ -58,6 +57,10 @@ protected void onParsingSuccess (ParserResult result) throws Exception
   }
   protected void onParsingError(String error, ParserResult result) throws Exception
   {
+    /* Until we move past the current block to the next block, parser remains in invalid
+     * state. */
+    mIsInvalidState = true;
+
     ParserEvents e = this.mParserEvents;
     if (e == null) return;
 
@@ -82,6 +85,42 @@ public AbstractParser (String fileName) throws FileNotFoundException, IOExceptio
     this.mLastLineRead = null;
     this.mLastFilePointer = -1;
     this.mParserEvents = null;
+    this.mIsInvalidState = false;
+  }
+
+  /**
+   * Moves to the Title of the next block from anywhere in the current block.
+   * Moves to the start of the next block. This methods, does not actually parse the lines, it
+   * just looks for the next termination line.
+   *
+   * Returns True, of next block was found, otherwise False.
+   */
+  public boolean moveToNextEntry() throws Exception
+  {
+    String linestr = null;
+
+    while (true)
+    {
+      linestr = readLineWithProperEncoding ();
+      if (linestr == null)
+        return false;
+
+      if (isTerminationLine (linestr))
+        break;
+    }
+
+    /* Move past any invalid block.*/
+    mIsInvalidState = false;
+    return true;
+  }
+
+  /**
+   * Moves the file pointer and assumes the next line read to be Title.
+   */
+  public void moveToEntryAtOffset (long offset) throws Exception
+  {
+    mFile.seek(offset);
+    mIsInvalidState = false;
   }
 
   protected Charset getCharsetFromByteOrderMarkType (ByteOrderMarkTypes type)
@@ -102,7 +141,6 @@ protected Charset getCharsetFromByteOrderMarkType (ByteOrderMarkTypes type)
    */
   public ParserResult parse() throws Exception
   {
-    ParsingErrors parseError = ParsingErrors.NO_ERROR;
     ParserResult result = new ParserResult();
 
     /* End of file was reached before */
@@ -112,14 +150,17 @@ public ParserResult parse() throws Exception
       return null;
     }
 
-    try {
+    try
+    {
       onParsingStart();
 
-      for (int i = 0; parseError == ParsingErrors.NO_ERROR; i++)
+      boolean isTerminationLineReached = false;
+      for (int i = 0; isTerminationLineReached  == false; i++)
       {
         if (Thread.interrupted() == true)
           throw new InterruptedException();
-        parseError = parseLine(i, result);
+
+        isTerminationLineReached = parseLine(i, result);
       }
 
     } catch (InterruptedException ex) {
@@ -130,20 +171,20 @@ public ParserResult parse() throws Exception
       throw ex;
     }
 
-    /* Parsing failed at some point*/
-    if (parseError == ParsingErrors.PARSING_ERROR)
-    {
-      String errDes = String.format ("Parsing error: '%s' is not '%s'.",
-                                      (isEOF() == true) ? "<EOF>" : this.lastLineRead(),
-                                      parseError.getTag());
-      onParsingError(errDes, result);
-      throw new ParserException (errDes);
-    }
-
     onParsingSuccess (result);
     return result;
   }
 
+  /** Generates a Parser Exception object for subclasses to use.
+   * This ensures a consistent Exception description.
+   */
+  protected ParserException genParserException (String field)
+  {
+      String errDes = String.format ("Invalid '%s' in line '%s'.",
+                                      field, this.lastLineRead());
+      return new ParserException (errDes);
+  }
+
   /**
    * Checks if End of File has been reached.
    */