Skip to content

Commit 9c0fa85

Browse files
authored
Code: Tex --> Latex (in the context of ParseLatex) (#6019)
1 parent 548d33c commit 9c0fa85

20 files changed

+203
-200
lines changed

src/main/java/org/jabref/gui/JabRefFrame.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@
9898
import org.jabref.gui.search.GlobalSearchBar;
9999
import org.jabref.gui.shared.ConnectToSharedDatabaseCommand;
100100
import org.jabref.gui.specialfields.SpecialFieldMenuItemFactory;
101-
import org.jabref.gui.texparser.ParseTexAction;
101+
import org.jabref.gui.texparser.ParseLatexAction;
102102
import org.jabref.gui.undo.CountingUndoManager;
103103
import org.jabref.gui.util.BackgroundTask;
104104
import org.jabref.gui.util.DefaultTaskExecutor;
@@ -786,7 +786,7 @@ private MenuBar createMenu() {
786786
pushToApplicationsManager.setMenuItem(pushToApplicationMenuItem);
787787

788788
tools.getItems().addAll(
789-
factory.createMenuItem(StandardActions.PARSE_TEX, new ParseTexAction(stateManager)),
789+
factory.createMenuItem(StandardActions.PARSE_LATEX, new ParseLatexAction(stateManager)),
790790
factory.createMenuItem(StandardActions.NEW_SUB_LIBRARY_FROM_AUX, new NewSubLibraryAction(this, stateManager)),
791791

792792
new SeparatorMenuItem(),

src/main/java/org/jabref/gui/actions/StandardActions.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@ public enum StandardActions implements Action {
8686
TOOGLE_OO(Localization.lang("OpenOffice/LibreOffice"), IconTheme.JabRefIcons.FILE_OPENOFFICE, KeyBinding.OPEN_OPEN_OFFICE_LIBRE_OFFICE_CONNECTION),
8787
TOGGLE_WEB_SEARCH(Localization.lang("Web search"), Localization.lang("Toggle web search interface"), IconTheme.JabRefIcons.WWW, KeyBinding.WEB_SEARCH),
8888

89-
PARSE_TEX(Localization.lang("Search for citations in LaTeX files..."), IconTheme.JabRefIcons.LATEX_CITATIONS),
89+
PARSE_LATEX(Localization.lang("Search for citations in LaTeX files..."), IconTheme.JabRefIcons.LATEX_CITATIONS),
9090
NEW_SUB_LIBRARY_FROM_AUX(Localization.lang("New sublibrary based on AUX file") + "...", Localization.lang("New BibTeX sublibrary") + Localization.lang("This feature generates a new library based on which entries are needed in an existing LaTeX document."), IconTheme.JabRefIcons.NEW),
9191
WRITE_XMP(Localization.lang("Write XMP metadata to PDFs"), Localization.lang("Will write XMP metadata to the PDFs linked from selected entries."), KeyBinding.WRITE_XMP),
9292
OPEN_FOLDER(Localization.lang("Open folder"), Localization.lang("Open folder"), KeyBinding.OPEN_FOLDER),

src/main/java/org/jabref/gui/entryeditor/LatexCitationsTabViewModel.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@
2626
import org.jabref.gui.util.DirectoryDialogConfiguration;
2727
import org.jabref.gui.util.TaskExecutor;
2828
import org.jabref.logic.l10n.Localization;
29-
import org.jabref.logic.texparser.DefaultTexParser;
29+
import org.jabref.logic.texparser.DefaultLatexParser;
3030
import org.jabref.model.database.BibDatabaseContext;
3131
import org.jabref.model.entry.BibEntry;
3232
import org.jabref.model.texparser.Citation;
33-
import org.jabref.model.texparser.TexParserResult;
33+
import org.jabref.model.texparser.LatexParserResult;
3434
import org.jabref.preferences.PreferencesService;
3535

3636
import org.slf4j.Logger;
@@ -56,7 +56,7 @@ enum Status {
5656
private final ObjectProperty<Status> status;
5757
private final StringProperty searchError;
5858
private Future<?> searchTask;
59-
private TexParserResult texParserResult;
59+
private LatexParserResult latexParserResult;
6060
private BibEntry currentEntry;
6161

6262
public LatexCitationsTabViewModel(BibDatabaseContext databaseContext, PreferencesService preferencesService,
@@ -129,18 +129,18 @@ private Collection<Citation> searchAndParse(String citeKey) throws IOException {
129129
Path newDirectory = databaseContext.getMetaData().getLatexFileDirectory(preferencesService.getUser())
130130
.orElseGet(preferencesService::getWorkingDir);
131131

132-
if (texParserResult == null || !newDirectory.equals(directory.get())) {
132+
if (latexParserResult == null || !newDirectory.equals(directory.get())) {
133133
directory.set(newDirectory);
134134

135135
if (!newDirectory.toFile().exists()) {
136136
throw new IOException(String.format("Current search directory does not exist: %s", newDirectory));
137137
}
138138

139139
List<Path> texFiles = searchDirectory(newDirectory, new ArrayList<>());
140-
texParserResult = new DefaultTexParser().parse(texFiles);
140+
latexParserResult = new DefaultLatexParser().parse(texFiles);
141141
}
142142

143-
return texParserResult.getCitationsByKey(citeKey);
143+
return latexParserResult.getCitationsByKey(citeKey);
144144
}
145145

146146
private List<Path> searchDirectory(Path directory, List<Path> texFiles) {

src/main/java/org/jabref/gui/texparser/ParseTexAction.java renamed to src/main/java/org/jabref/gui/texparser/ParseLatexAction.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,19 +5,19 @@
55
import org.jabref.gui.actions.SimpleCommand;
66
import org.jabref.model.database.BibDatabaseContext;
77

8-
public class ParseTexAction extends SimpleCommand {
8+
public class ParseLatexAction extends SimpleCommand {
99

1010
private final StateManager stateManager;
1111

12-
public ParseTexAction(StateManager stateManager) {
12+
public ParseLatexAction(StateManager stateManager) {
1313
this.stateManager = stateManager;
1414
executable.bind(ActionHelper.needsDatabase(stateManager));
1515
}
1616

1717
@Override
1818
public void execute() {
1919
BibDatabaseContext database = stateManager.getActiveDatabase().orElseThrow(NullPointerException::new);
20-
ParseTexDialogView dialog = new ParseTexDialogView(database);
20+
ParseLatexDialogView dialog = new ParseLatexDialogView(database);
2121
dialog.showAndWait();
2222
}
2323
}

src/main/java/org/jabref/gui/texparser/ParseTexDialog.fxml renamed to src/main/java/org/jabref/gui/texparser/ParseLatexDialog.fxml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -10,14 +10,14 @@
1010
<?import javafx.scene.layout.VBox?>
1111
<?import org.controlsfx.control.CheckTreeView?>
1212
<DialogPane xmlns="http://javafx.com/javafx/8.0.171" xmlns:fx="http://javafx.com/fxml/1"
13-
fx:controller="org.jabref.gui.texparser.ParseTexDialogView"
13+
fx:controller="org.jabref.gui.texparser.ParseLatexDialogView"
1414
prefWidth="500.0" prefHeight="650.0">
1515
<content>
1616
<VBox spacing="10.0">
1717
<VBox spacing="5.0">
1818
<Label text="%LaTeX files directory:"/>
1919
<HBox spacing="10.0">
20-
<TextField fx:id="texDirectoryField" HBox.hgrow="ALWAYS"/>
20+
<TextField fx:id="latexDirectoryField" HBox.hgrow="ALWAYS"/>
2121
<Button fx:id="browseButton" onAction="#browseButtonClicked" text="%Browse"/>
2222
<Button fx:id="searchButton" defaultButton="true" onAction="#searchButtonClicked" text="%Search"/>
2323
</HBox>

src/main/java/org/jabref/gui/texparser/ParseTexDialogView.java renamed to src/main/java/org/jabref/gui/texparser/ParseLatexDialogView.java

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -28,11 +28,11 @@
2828
import org.controlsfx.control.CheckTreeView;
2929
import org.fxmisc.easybind.EasyBind;
3030

31-
public class ParseTexDialogView extends BaseDialog<Void> {
31+
public class ParseLatexDialogView extends BaseDialog<Void> {
3232

3333
private final BibDatabaseContext databaseContext;
3434
private final ControlsFxVisualizer validationVisualizer;
35-
@FXML private TextField texDirectoryField;
35+
@FXML private TextField latexDirectoryField;
3636
@FXML private Button browseButton;
3737
@FXML private Button searchButton;
3838
@FXML private ProgressIndicator progressIndicator;
@@ -44,9 +44,9 @@ public class ParseTexDialogView extends BaseDialog<Void> {
4444
@Inject private TaskExecutor taskExecutor;
4545
@Inject private PreferencesService preferencesService;
4646
@Inject private FileUpdateMonitor fileMonitor;
47-
private ParseTexDialogViewModel viewModel;
47+
private ParseLatexDialogViewModel viewModel;
4848

49-
public ParseTexDialogView(BibDatabaseContext databaseContext) {
49+
public ParseLatexDialogView(BibDatabaseContext databaseContext) {
5050
this.databaseContext = databaseContext;
5151
this.validationVisualizer = new ControlsFxVisualizer();
5252

@@ -62,7 +62,7 @@ public ParseTexDialogView(BibDatabaseContext databaseContext) {
6262

6363
@FXML
6464
private void initialize() {
65-
viewModel = new ParseTexDialogViewModel(databaseContext, dialogService, taskExecutor, preferencesService, fileMonitor);
65+
viewModel = new ParseLatexDialogViewModel(databaseContext, dialogService, taskExecutor, preferencesService, fileMonitor);
6666

6767
fileTreeView.getSelectionModel().setSelectionMode(SelectionMode.MULTIPLE);
6868
fileTreeView.showRootProperty().bindBidirectional(viewModel.successfulSearchProperty());
@@ -79,11 +79,11 @@ private void initialize() {
7979
EasyBind.listBind(viewModel.getCheckedFileList(), fileTreeView.getCheckModel().getCheckedItems());
8080
});
8181

82-
texDirectoryField.textProperty().bindBidirectional(viewModel.texDirectoryProperty());
82+
latexDirectoryField.textProperty().bindBidirectional(viewModel.latexFileDirectoryProperty());
8383
validationVisualizer.setDecoration(new IconValidationDecorator());
84-
validationVisualizer.initVisualization(viewModel.texDirectoryValidation(), texDirectoryField);
84+
validationVisualizer.initVisualization(viewModel.latexDirectoryValidation(), latexDirectoryField);
8585
browseButton.disableProperty().bindBidirectional(viewModel.searchInProgressProperty());
86-
searchButton.disableProperty().bind(viewModel.texDirectoryValidation().validProperty().not());
86+
searchButton.disableProperty().bind(viewModel.latexDirectoryValidation().validProperty().not());
8787
selectAllButton.disableProperty().bindBidirectional(viewModel.noFilesFoundProperty());
8888
unselectAllButton.disableProperty().bindBidirectional(viewModel.noFilesFoundProperty());
8989
progressIndicator.visibleProperty().bindBidirectional(viewModel.searchInProgressProperty());

src/main/java/org/jabref/gui/texparser/ParseTexDialogViewModel.java renamed to src/main/java/org/jabref/gui/texparser/ParseLatexDialogViewModel.java

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
import org.jabref.gui.util.DirectoryDialogConfiguration;
2929
import org.jabref.gui.util.TaskExecutor;
3030
import org.jabref.logic.l10n.Localization;
31-
import org.jabref.logic.texparser.DefaultTexParser;
31+
import org.jabref.logic.texparser.DefaultLatexParser;
3232
import org.jabref.logic.texparser.TexBibEntriesResolver;
3333
import org.jabref.model.database.BibDatabaseContext;
3434
import org.jabref.model.util.FileUpdateMonitor;
@@ -41,51 +41,51 @@
4141
import org.slf4j.Logger;
4242
import org.slf4j.LoggerFactory;
4343

44-
public class ParseTexDialogViewModel extends AbstractViewModel {
44+
public class ParseLatexDialogViewModel extends AbstractViewModel {
4545

46-
private static final Logger LOGGER = LoggerFactory.getLogger(ParseTexDialogViewModel.class);
46+
private static final Logger LOGGER = LoggerFactory.getLogger(ParseLatexDialogViewModel.class);
4747
private static final String TEX_EXT = ".tex";
4848
private final BibDatabaseContext databaseContext;
4949
private final DialogService dialogService;
5050
private final TaskExecutor taskExecutor;
5151
private final PreferencesService preferencesService;
5252
private final FileUpdateMonitor fileMonitor;
53-
private final StringProperty texDirectory;
54-
private final Validator texDirectoryValidator;
53+
private final StringProperty latexFileDirectory;
54+
private final Validator latexDirectoryValidator;
5555
private final ObjectProperty<FileNodeViewModel> root;
5656
private final ObservableList<TreeItem<FileNodeViewModel>> checkedFileList;
5757
private final BooleanProperty noFilesFound;
5858
private final BooleanProperty searchInProgress;
5959
private final BooleanProperty successfulSearch;
6060

61-
public ParseTexDialogViewModel(BibDatabaseContext databaseContext, DialogService dialogService,
62-
TaskExecutor taskExecutor, PreferencesService preferencesService,
63-
FileUpdateMonitor fileMonitor) {
61+
public ParseLatexDialogViewModel(BibDatabaseContext databaseContext, DialogService dialogService,
62+
TaskExecutor taskExecutor, PreferencesService preferencesService,
63+
FileUpdateMonitor fileMonitor) {
6464
this.databaseContext = databaseContext;
6565
this.dialogService = dialogService;
6666
this.taskExecutor = taskExecutor;
6767
this.preferencesService = preferencesService;
6868
this.fileMonitor = fileMonitor;
69-
this.texDirectory = new SimpleStringProperty(databaseContext.getMetaData().getLatexFileDirectory(preferencesService.getUser())
70-
.orElseGet(preferencesService::getWorkingDir)
71-
.toAbsolutePath().toString());
69+
this.latexFileDirectory = new SimpleStringProperty(databaseContext.getMetaData().getLatexFileDirectory(preferencesService.getUser())
70+
.orElseGet(preferencesService::getWorkingDir)
71+
.toAbsolutePath().toString());
7272
this.root = new SimpleObjectProperty<>();
7373
this.checkedFileList = FXCollections.observableArrayList();
7474
this.noFilesFound = new SimpleBooleanProperty(true);
7575
this.searchInProgress = new SimpleBooleanProperty(false);
7676
this.successfulSearch = new SimpleBooleanProperty(false);
7777

7878
Predicate<String> isDirectory = path -> Paths.get(path).toFile().isDirectory();
79-
texDirectoryValidator = new FunctionBasedValidator<>(texDirectory, isDirectory,
79+
latexDirectoryValidator = new FunctionBasedValidator<>(latexFileDirectory, isDirectory,
8080
ValidationMessage.error(Localization.lang("Please enter a valid file path.")));
8181
}
8282

83-
public StringProperty texDirectoryProperty() {
84-
return texDirectory;
83+
public StringProperty latexFileDirectoryProperty() {
84+
return latexFileDirectory;
8585
}
8686

87-
public ValidationStatus texDirectoryValidation() {
88-
return texDirectoryValidator.getValidationStatus();
87+
public ValidationStatus latexDirectoryValidation() {
88+
return latexDirectoryValidator.getValidationStatus();
8989
}
9090

9191
public ObjectProperty<FileNodeViewModel> rootProperty() {
@@ -110,10 +110,10 @@ public BooleanProperty successfulSearchProperty() {
110110

111111
public void browseButtonClicked() {
112112
DirectoryDialogConfiguration directoryDialogConfiguration = new DirectoryDialogConfiguration.Builder()
113-
.withInitialDirectory(Paths.get(texDirectory.get())).build();
113+
.withInitialDirectory(Paths.get(latexFileDirectory.get())).build();
114114

115115
dialogService.showDirectorySelectionDialog(directoryDialogConfiguration).ifPresent(selectedDirectory -> {
116-
texDirectory.set(selectedDirectory.toAbsolutePath().toString());
116+
latexFileDirectory.set(selectedDirectory.toAbsolutePath().toString());
117117
preferencesService.setWorkingDir(selectedDirectory.toAbsolutePath());
118118
});
119119
}
@@ -122,7 +122,7 @@ public void browseButtonClicked() {
122122
* Run a recursive search in a background task.
123123
*/
124124
public void searchButtonClicked() {
125-
BackgroundTask.wrap(() -> searchDirectory(Paths.get(texDirectory.get())))
125+
BackgroundTask.wrap(() -> searchDirectory(Paths.get(latexFileDirectory.get())))
126126
.onRunning(() -> {
127127
root.set(null);
128128
noFilesFound.set(true);
@@ -202,10 +202,10 @@ public void parseButtonClicked() {
202202
TexBibEntriesResolver entriesResolver = new TexBibEntriesResolver(databaseContext.getDatabase(),
203203
preferencesService.getImportFormatPreferences(), fileMonitor);
204204

205-
BackgroundTask.wrap(() -> entriesResolver.resolve(new DefaultTexParser().parse(fileList)))
205+
BackgroundTask.wrap(() -> entriesResolver.resolve(new DefaultLatexParser().parse(fileList)))
206206
.onRunning(() -> searchInProgress.set(true))
207207
.onFinished(() -> searchInProgress.set(false))
208-
.onSuccess(result -> new ParseTexResultView(result, databaseContext, Paths.get(texDirectory.get())).showAndWait())
208+
.onSuccess(result -> new ParseLatexResultView(result, databaseContext, Paths.get(latexFileDirectory.get())).showAndWait())
209209
.onFailure(dialogService::showErrorDialogAndWait)
210210
.executeWith(taskExecutor);
211211
}

src/main/java/org/jabref/gui/texparser/ParseTexResult.fxml renamed to src/main/java/org/jabref/gui/texparser/ParseLatexResult.fxml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99
<?import javafx.scene.control.SplitPane?>
1010

1111
<DialogPane xmlns="http://javafx.com/javafx/8.0.171" xmlns:fx="http://javafx.com/fxml/1"
12-
fx:controller="org.jabref.gui.texparser.ParseTexResultView"
12+
fx:controller="org.jabref.gui.texparser.ParseLatexResultView"
1313
prefWidth="900.0" prefHeight="600.0">
1414
<content>
1515
<SplitPane dividerPositions="0.2">

src/main/java/org/jabref/gui/texparser/ParseTexResultView.java renamed to src/main/java/org/jabref/gui/texparser/ParseLatexResultView.java

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -13,22 +13,22 @@
1313
import org.jabref.gui.util.ViewModelListCellFactory;
1414
import org.jabref.logic.l10n.Localization;
1515
import org.jabref.model.database.BibDatabaseContext;
16-
import org.jabref.model.texparser.TexBibEntriesResolverResult;
16+
import org.jabref.model.texparser.LatexBibEntriesResolverResult;
1717

1818
import com.airhacks.afterburner.views.ViewLoader;
1919
import org.fxmisc.easybind.EasyBind;
2020

21-
public class ParseTexResultView extends BaseDialog<Void> {
21+
public class ParseLatexResultView extends BaseDialog<Void> {
2222

23-
private final TexBibEntriesResolverResult resolverResult;
23+
private final LatexBibEntriesResolverResult resolverResult;
2424
private final BibDatabaseContext databaseContext;
2525
private final Path basePath;
2626
@FXML private ListView<ReferenceViewModel> referenceListView;
2727
@FXML private CitationsDisplay citationsDisplay;
2828
@FXML private ButtonType importButtonType;
29-
private ParseTexResultViewModel viewModel;
29+
private ParseLatexResultViewModel viewModel;
3030

31-
public ParseTexResultView(TexBibEntriesResolverResult resolverResult, BibDatabaseContext databaseContext, Path basePath) {
31+
public ParseLatexResultView(LatexBibEntriesResolverResult resolverResult, BibDatabaseContext databaseContext, Path basePath) {
3232
this.resolverResult = resolverResult;
3333
this.databaseContext = databaseContext;
3434
this.basePath = basePath;
@@ -47,7 +47,7 @@ public ParseTexResultView(TexBibEntriesResolverResult resolverResult, BibDatabas
4747

4848
@FXML
4949
private void initialize() {
50-
viewModel = new ParseTexResultViewModel(resolverResult, databaseContext);
50+
viewModel = new ParseLatexResultViewModel(resolverResult, databaseContext);
5151

5252
referenceListView.setItems(viewModel.getReferenceList());
5353
referenceListView.getSelectionModel().selectFirst();

0 commit comments

Comments
 (0)