Oobranch f : add frontend

src/main/java/org/jabref/gui/openoffice/ConnectionLostException.java

@@ -5,7 +5,7 @@
  */
 class ConnectionLostException extends RuntimeException {
 
- public ConnectionLostException(String s) {
- super(s);
+ public ConnectionLostException(String msg) {
+ super(msg);
  }
 }

src/main/java/org/jabref/logic/openoffice/OOUtil.java

@@ -127,13 +127,13 @@ public static void insertOOFormattedTextAtCurrentLocation(XText text, XTextCurso
  List<Formatting> formatting = new ArrayList<>();
  // We need to extract formatting. Use a simple regexp search iteration:
  int piv = 0;
- Matcher m = OOUtil.HTML_TAG.matcher(lText);
- while (m.find()) {
- String currentSubstring = lText.substring(piv, m.start());
+ Matcher matcher = OOUtil.HTML_TAG.matcher(lText);
+ while (matcher.find()) {
+ String currentSubstring = lText.substring(piv, matcher.start());
  if (!currentSubstring.isEmpty()) {
  OOUtil.insertTextAtCurrentLocation(text, cursor, currentSubstring, formatting);
  }
- String tag = m.group();
+ String tag = matcher.group();
  // Handle tags:
  if ("<b>".equals(tag)) {
  formatting.add(Formatting.BOLD);
@@ -169,7 +169,7 @@ public static void insertOOFormattedTextAtCurrentLocation(XText text, XTextCurso
  formatting.remove(Formatting.STRIKEOUT);
  }
 
- piv = m.end();
+ piv = matcher.end();
  }
 
  if (piv < lText.length()) {
@@ -276,10 +276,9 @@ public static void insertTextAtCurrentLocation(XText text, XTextCursor cursor, S
  cursor.collapseToEnd();
  }
 
- public static Object getProperty(Object o, String property)
+ public static Object getProperty(Object object, String property)
  throws UnknownPropertyException, WrappedTargetException {
- XPropertySet props = UnoRuntime.queryInterface(
- XPropertySet.class, o);
+ XPropertySet props = UnoRuntime.queryInterface(XPropertySet.class, object);
  return props.getPropertyValue(property);
  }
 }

src/main/java/org/jabref/logic/openoffice/backend/Backend52.java

@@ -196,17 +196,6 @@ public CitationGroup createCitationGroup(XTextDocument doc,
  throw new IllegalArgumentException();
  }
 
- /*
- * Backend52 uses reference marks to (1) mark the location of the citation in the text and (2) to encode
- * the citation keys and citation type in the name of the reference mark. The name of the reference mark
- * has to be unique in the document.
- */
- String markName = Codec52.getUniqueMarkName(new HashSet<>(citationStorageManager.getUsedNames(doc)),
- citationKeys,
- citationType);
-
- CitationGroupId groupId = new CitationGroupId(markName);
-
  final int numberOfCitations = citationKeys.size();
  final int last = numberOfCitations - 1;
 
@@ -236,6 +225,17 @@ public CitationGroup createCitationGroup(XTextDocument doc,
  }
  }
 
+ /*
+ * Backend52 uses reference marks to (1) mark the location of the citation in the text and (2) to encode
+ * the citation keys and citation type in the name of the reference mark. The name of the reference mark
+ * has to be unique in the document.
+ */
+ final String markName = Codec52.getUniqueMarkName(new HashSet<>(citationStorageManager.getUsedNames(doc)),
+ citationKeys,
+ citationType);
+
+ final CitationGroupId groupId = new CitationGroupId(markName);
+
  /*
  * Apply to document
  */

src/main/java/org/jabref/logic/openoffice/backend/Codec52.java

@@ -32,16 +32,16 @@ private Codec52() {
  */
  public static class ParsedMarkName {
  /** "", "0", "1" ... */
- public final String i;
+ public final String index;
  /** in-text-citation type */
  public final CitationType citationType;
  /** Citation keys embedded in the reference mark. */
  public final List<String> citationKeys;
 
- ParsedMarkName(String i, CitationType citationType, List<String> citationKeys) {
- Objects.requireNonNull(i);
+ ParsedMarkName(String index, CitationType citationType, List<String> citationKeys) {
+ Objects.requireNonNull(index);
  Objects.requireNonNull(citationKeys);
- this.i = i;
+ this.index = index;
  this.citationType = citationType;
  this.citationKeys = citationKeys;
  }
@@ -50,17 +50,17 @@ public static class ParsedMarkName {
  /**
  * Integer representation was written into the document in JabRef52, keep it for compatibility.
  */
- private static CitationType citationTypeFromInt(int i) {
- return switch (i) {
+ private static CitationType citationTypeFromInt(int code) {
+ return switch (code) {
  case 1 -> CitationType.AUTHORYEAR_PAR;
  case 2 -> CitationType.AUTHORYEAR_INTEXT;
  case 3 -> CitationType.INVISIBLE_CIT;
  default -> throw new IllegalArgumentException("Invalid CitationType code");
  };
  }
 
- private static int citationTypeToInt(CitationType i) {
- return switch (i) {
+ private static int citationTypeToInt(CitationType type) {
+ return switch (type) {
  case AUTHORYEAR_PAR -> 1;
  case AUTHORYEAR_INTEXT -> 2;
  case INVISIBLE_CIT -> 3;
@@ -86,12 +86,12 @@ public static String getUniqueMarkName(Set<String> usedNames,
 
  String citationKeysPart = String.join(",", citationKeys);
 
- int i = 0;
+ int index = 0;
  int citTypeCode = citationTypeToInt(citationType);
  String name = BIB_CITATION + '_' + citTypeCode + '_' + citationKeysPart;
  while (usedNames.contains(name)) {
- name = BIB_CITATION + i + '_' + citTypeCode + '_' + citationKeysPart;
- i++;
+ name = BIB_CITATION + index + '_' + citTypeCode + '_' + citationKeysPart;
+ index++;
  }
  return name;
  }
@@ -110,10 +110,10 @@ public static Optional<ParsedMarkName> parseMarkName(String refMarkName) {
  }
 
  List<String> keys = Arrays.asList(citeMatcher.group(3).split(","));
- String i = citeMatcher.group(1);
+ String index = citeMatcher.group(1);
  int citTypeCode = Integer.parseInt(citeMatcher.group(2));
  CitationType citationType = citationTypeFromInt(citTypeCode);
- return (Optional.of(new Codec52.ParsedMarkName(i, citationType, keys)));
+ return (Optional.of(new Codec52.ParsedMarkName(index, citationType, keys)));
  }
 
  /**

src/main/java/org/jabref/logic/openoffice/backend/NamedRangeReferenceMark.java

@@ -35,14 +35,14 @@ class NamedRangeReferenceMark implements NamedRange {
 
  private static final Logger LOGGER = LoggerFactory.getLogger(NamedRangeReferenceMark.class);
 
- private String id; /* reference mark name */
+ private String rangeId; /* reference mark name */
 
- private NamedRangeReferenceMark(String id) {
- this.id = id;
+ private NamedRangeReferenceMark(String rangeId) {
+ this.rangeId = rangeId;
  }
 
  String getId() {
- return id;
+ return rangeId;
  }
 
  /**
@@ -156,7 +156,7 @@ public void removeFromDocument(XTextDocument doc)
 
  @Override
  public String getRangeName() {
- return id;
+ return rangeId;
  }
 
  /**
@@ -217,8 +217,6 @@ public XTextCursor getFillCursor(XTextDocument doc)
 
  String name = this.getRangeName();
 
- final String left = NamedRangeReferenceMark.REFERENCE_MARK_LEFT_BRACKET;
- final String right = NamedRangeReferenceMark.REFERENCE_MARK_RIGHT_BRACKET;
  final boolean debugThisFun = false;
 
  XTextCursor full = null;
@@ -279,6 +277,8 @@ public XTextCursor getFillCursor(XTextDocument doc)
  beta.goRight((short) (fullText.length() - 2), true);
  LOGGER.debug("getFillCursor: beta(1) covers '{}'", beta.getString());
 
+ final String left = NamedRangeReferenceMark.REFERENCE_MARK_LEFT_BRACKET;
+ final String right = NamedRangeReferenceMark.REFERENCE_MARK_RIGHT_BRACKET;
  final short rightLength = (short) right.length();
  if (fullText.startsWith(left) && fullText.endsWith(right)) {
  beta.setString("");
@@ -345,7 +345,6 @@ public XTextCursor getFillCursor(XTextDocument doc)
  */
  public static void checkFillCursor(XTextCursor cursor) {
  final String left = REFERENCE_MARK_LEFT_BRACKET;
- final String right = REFERENCE_MARK_RIGHT_BRACKET;
 
  XTextCursor alpha = cursor.getText().createTextCursorByRange(cursor);
  alpha.collapseToStart();
@@ -364,6 +363,7 @@ public static void checkFillCursor(XTextCursor cursor) {
  }
  }
 
+ final String right = REFERENCE_MARK_RIGHT_BRACKET;
  final short rightLength = (short) right.length();
  if (rightLength > 0) {
  omega.goRight(rightLength, true);
@@ -395,27 +395,26 @@ public void cleanFillCursor(XTextDocument doc)
  // removeBracketsFromEmpty is intended to force removal if we are working on an "Empty citation" (INVISIBLE_CIT).
  final boolean removeBracketsFromEmpty = false;
 
- final String left = REFERENCE_MARK_LEFT_BRACKET;
- final String right = REFERENCE_MARK_RIGHT_BRACKET;
- final short leftLength = (short) left.length();
- final short rightLength = (short) right.length();
-
  String name = this.getRangeName();
 
  XTextCursor full = this.getRawCursor(doc).orElseThrow(IllegalStateException::new);
  final String fullText = full.getString();
- final int fullTextLength = fullText.length();
 
+ final String left = REFERENCE_MARK_LEFT_BRACKET;
  if (!fullText.startsWith(left)) {
  String msg = String.format("cleanFillCursor: (%s) does not start with REFERENCE_MARK_LEFT_BRACKET", name);
  throw new IllegalStateException(msg);
  }
 
+ final String right = REFERENCE_MARK_RIGHT_BRACKET;
  if (!fullText.endsWith(right)) {
  String msg = String.format("cleanFillCursor: (%s) does not end with REFERENCE_MARK_RIGHT_BRACKET", name);
  throw new IllegalStateException(msg);
  }
 
+ final int fullTextLength = fullText.length();
+ final short leftLength = (short) left.length();
+ final short rightLength = (short) right.length();
  final int contentLength = (fullTextLength - (leftLength + rightLength));
  if (contentLength < 0) {
  String msg = String.format("cleanFillCursor: length(%s) < 0", name);