Move bst package to logic (#1587)

* Move bst package into logic

* Set new location of bst package for antlr

* Add changelog entry

* Reformulate changelog entry

CHANGELOG.md

@@ -12,6 +12,7 @@ We refer to [GitHub issues](https://github.com/JabRef/jabref/issues) by using `#
 ## [Unreleased]
 
 ### Changed
+- For developers: Moved the bst package into logic. This requires the regeneration of antlr sources, execute: gradlew generateSource
 - [#1026](https://github.com/JabRef/jabref/issues/1026) JabRef does no longer delete user comments outside of BibTeX entries and strings
 - [#1249](https://github.com/JabRef/jabref/issues/1249) Date layout formatter added
 

build.gradle

@@ -164,12 +164,12 @@ task generateBstGrammarSource(type: JavaExec) {
     File antlrSource = file('src/main/antlr3/net/sf/jabref/bst/Bst.g')
 
     inputs.file antlrSource
-    outputs.file file('src/main/gen/net/sf/jabref/bst/BstLexer.java')
-    outputs.file file('src/main/gen/net/sf/jabref/bst/BstParser.java')
+    outputs.file file('src/main/gen/net/sf/jabref/logic/bst/BstLexer.java')
+    outputs.file file('src/main/gen/net/sf/jabref/logic/bst/BstParser.java')
 
     main = 'org.antlr.Tool'
     classpath = configurations.antlr3
-    args = ["-o", file('src/main/gen/net/sf/jabref/bst/'), antlrSource]
+    args = ["-o", file('src/main/gen/net/sf/jabref/logic/bst/'), antlrSource]
 }
 
 task generateSearchGrammarSource(type: JavaExec) {

src/main/antlr3/net/sf/jabref/bst/Bst.g

@@ -13,11 +13,11 @@ tokens {
 
 // applies only to the parser:
 @header {// Generated by ANTLR
-package net.sf.jabref.bst;}
+package net.sf.jabref.logic.bst;}
 
 // applies only to the lexer:
 @lexer::header {// Generated by ANTLR
-package net.sf.jabref.bst;}
+package net.sf.jabref.logic.bst;}
 
 program : commands+ -> ^(COMMANDS commands+);
 

src/main/java/net/sf/jabref/bst/BibtexCaseChanger.java → src/main/java/net/sf/jabref/logic/bst/BibtexCaseChanger.java

@@ -13,7 +13,7 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import java.util.Optional;
 

src/main/java/net/sf/jabref/bst/BibtexNameFormatter.java → src/main/java/net/sf/jabref/logic/bst/BibtexNameFormatter.java

@@ -13,7 +13,7 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import java.util.Arrays;
 import java.util.stream.Collectors;

src/main/java/net/sf/jabref/bst/BibtexPurify.java → src/main/java/net/sf/jabref/logic/bst/BibtexPurify.java

@@ -14,7 +14,7 @@
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 // $Id$
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 /**
  *

src/main/java/net/sf/jabref/bst/BibtexTextPrefix.java → src/main/java/net/sf/jabref/logic/bst/BibtexTextPrefix.java

@@ -14,7 +14,7 @@
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 // $Id$
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 /**
  * The |built_in| function {\.{text.prefix\$}} pops the top two literals (the

src/main/java/net/sf/jabref/bst/BibtexWidth.java → src/main/java/net/sf/jabref/logic/bst/BibtexWidth.java

@@ -14,7 +14,7 @@
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
 // $Id$
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;

src/main/java/net/sf/jabref/bst/ChangeCaseFunction.java → src/main/java/net/sf/jabref/logic/bst/ChangeCaseFunction.java

@@ -13,13 +13,13 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import java.util.Stack;
 
-import net.sf.jabref.bst.BibtexCaseChanger.FORMAT_MODE;
-import net.sf.jabref.bst.VM.BstEntry;
-import net.sf.jabref.bst.VM.BstFunction;
+import net.sf.jabref.logic.bst.BibtexCaseChanger.FORMAT_MODE;
+import net.sf.jabref.logic.bst.VM.BstEntry;
+import net.sf.jabref.logic.bst.VM.BstFunction;
 
 /**
  * From the Bibtex manual:

src/main/java/net/sf/jabref/bst/FormatNameFunction.java → src/main/java/net/sf/jabref/logic/bst/FormatNameFunction.java

@@ -13,12 +13,12 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import java.util.Stack;
 
-import net.sf.jabref.bst.VM.BstEntry;
-import net.sf.jabref.bst.VM.BstFunction;
+import net.sf.jabref.logic.bst.VM.BstEntry;
+import net.sf.jabref.logic.bst.VM.BstFunction;
 import net.sf.jabref.model.entry.Author;
 import net.sf.jabref.model.entry.AuthorList;
 

src/main/java/net/sf/jabref/bst/PurifyFunction.java → src/main/java/net/sf/jabref/logic/bst/PurifyFunction.java

@@ -13,12 +13,12 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import java.util.Stack;
 
-import net.sf.jabref.bst.VM.BstEntry;
-import net.sf.jabref.bst.VM.BstFunction;
+import net.sf.jabref.logic.bst.VM.BstEntry;
+import net.sf.jabref.logic.bst.VM.BstFunction;
 
 /**
  *

src/main/java/net/sf/jabref/bst/TextPrefixFunction.java → src/main/java/net/sf/jabref/logic/bst/TextPrefixFunction.java

@@ -13,12 +13,12 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import java.util.Stack;
 
-import net.sf.jabref.bst.VM.BstEntry;
-import net.sf.jabref.bst.VM.BstFunction;
+import net.sf.jabref.logic.bst.VM.BstEntry;
+import net.sf.jabref.logic.bst.VM.BstFunction;
 
 /**
  The |built_in| function {\.{text.prefix\$}} pops the top two literals

src/main/java/net/sf/jabref/bst/VM.java → src/main/java/net/sf/jabref/logic/bst/VM.java

@@ -13,7 +13,7 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import java.io.File;
 import java.io.IOException;

src/main/java/net/sf/jabref/bst/VMException.java → src/main/java/net/sf/jabref/logic/bst/VMException.java

@@ -13,7 +13,7 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 public class VMException extends RuntimeException {
 

src/main/java/net/sf/jabref/bst/Warn.java → src/main/java/net/sf/jabref/logic/bst/Warn.java

@@ -13,7 +13,7 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 @FunctionalInterface
 public interface Warn {

src/main/java/net/sf/jabref/bst/WidthFunction.java → src/main/java/net/sf/jabref/logic/bst/WidthFunction.java

@@ -13,12 +13,12 @@
     with this program; if not, write to the Free Software Foundation, Inc.,
     51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 */
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import java.util.Stack;
 
-import net.sf.jabref.bst.VM.BstEntry;
-import net.sf.jabref.bst.VM.BstFunction;
+import net.sf.jabref.logic.bst.VM.BstEntry;
+import net.sf.jabref.logic.bst.VM.BstFunction;
 
 /**
  * The |built_in| function {\.{width\$}} pops the top (string) literal and

src/main/java/net/sf/jabref/logic/layout/format/NameFormatter.java

@@ -20,7 +20,7 @@
 import java.util.Map;
 
 import net.sf.jabref.Globals;
-import net.sf.jabref.bst.BibtexNameFormatter;
+import net.sf.jabref.logic.bst.BibtexNameFormatter;
 import net.sf.jabref.logic.layout.LayoutFormatter;
 import net.sf.jabref.model.entry.AuthorList;
 

src/test/java/net/sf/jabref/bst/BibtexCaseChangersTest.java → src/test/java/net/sf/jabref/logic/bst/BibtexCaseChangersTest.java

@@ -1,6 +1,6 @@
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
-import net.sf.jabref.bst.BibtexCaseChanger.FORMAT_MODE;
+import net.sf.jabref.logic.bst.BibtexCaseChanger.FORMAT_MODE;
 
 import org.junit.Assert;
 import org.junit.Test;

src/test/java/net/sf/jabref/bst/BibtexNameFormatterTest.java → src/test/java/net/sf/jabref/logic/bst/BibtexNameFormatterTest.java

@@ -1,4 +1,4 @@
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import net.sf.jabref.model.entry.AuthorList;
 

src/test/java/net/sf/jabref/bst/BibtexPurifyTest.java → src/test/java/net/sf/jabref/logic/bst/BibtexPurifyTest.java

@@ -1,4 +1,4 @@
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import org.junit.Assert;
 import org.junit.Test;

src/test/java/net/sf/jabref/bst/BibtexWidthTest.java → src/test/java/net/sf/jabref/logic/bst/BibtexWidthTest.java

@@ -1,4 +1,4 @@
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import org.junit.Assert;
 import org.junit.Test;

src/test/java/net/sf/jabref/bst/TestVM.java → src/test/java/net/sf/jabref/logic/bst/TestVM.java

@@ -1,4 +1,4 @@
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import java.io.File;
 import java.io.IOException;
@@ -9,10 +9,10 @@
 
 import net.sf.jabref.Globals;
 import net.sf.jabref.JabRefPreferences;
-import net.sf.jabref.bst.VM.BstEntry;
-import net.sf.jabref.bst.VM.StackFunction;
 import net.sf.jabref.importer.ParserResult;
 import net.sf.jabref.importer.fileformat.BibtexParser;
+import net.sf.jabref.logic.bst.VM.BstEntry;
+import net.sf.jabref.logic.bst.VM.StackFunction;
 import net.sf.jabref.model.entry.BibEntry;
 
 import org.antlr.runtime.RecognitionException;
@@ -30,7 +30,7 @@ public void setPreferences() {
 
     @Test
     public void testAbbrv() throws RecognitionException, IOException {
-        VM vm = new VM(new File("src/test/resources/net/sf/jabref/bst/abbrv.bst"));
+        VM vm = new VM(new File("src/test/resources/net/sf/jabref/logic/bst/abbrv.bst"));
         List<BibEntry> v = new ArrayList<>();
         v.add(t1BibtexEntry());
 
@@ -664,7 +664,7 @@ private String t1BibtexString() {
 
     @Test
     public void testHypthenatedName() throws RecognitionException, IOException {
-        VM vm = new VM(new File("src/test/resources/net/sf/jabref/bst/abbrv.bst"));
+        VM vm = new VM(new File("src/test/resources/net/sf/jabref/logic/bst/abbrv.bst"));
         List<BibEntry> v = new ArrayList<>();
         v.add(TestVM.bibtexString2BibtexEntry("@article{canh05, author = \"Jean-Paul Sartre\" }"));
         Assert.assertTrue(vm.run(v).contains("J.-P. Sartre"));

src/test/java/net/sf/jabref/bst/TextPrefixFunctionTest.java → src/test/java/net/sf/jabref/logic/bst/TextPrefixFunctionTest.java

@@ -1,4 +1,4 @@
-package net.sf.jabref.bst;
+package net.sf.jabref.logic.bst;
 
 import org.junit.Assert;
 import org.junit.Test;