| 47 | 47 | import static com.keenwrite.preferences.AppKeys.*; |
| 48 | 48 | import static com.keenwrite.processors.ProcessorFactory.createProcessors; |
| 49 | | import static com.keenwrite.ui.explorer.FilePickerFactory.Options; |
| 50 | | import static com.keenwrite.ui.explorer.FilePickerFactory.Options.*; |
| 51 | | import static com.keenwrite.util.FileWalker.walk; |
| 52 | | import static java.nio.file.Files.readString; |
| 53 | | import static java.nio.file.Files.writeString; |
| 54 | | import static java.util.concurrent.Executors.newFixedThreadPool; |
| 55 | | import static javafx.application.Platform.runLater; |
| 56 | | import static javafx.event.Event.fireEvent; |
| 57 | | import static javafx.scene.control.Alert.AlertType.INFORMATION; |
| 58 | | import static javafx.stage.WindowEvent.WINDOW_CLOSE_REQUEST; |
| 59 | | import static org.apache.commons.io.FilenameUtils.getExtension; |
| 60 | | |
| 61 | | /** |
| 62 | | * Responsible for abstracting how functionality is mapped to the application. |
| 63 | | * This allows users to customize accelerator keys and will provide pluggable |
| 64 | | * functionality so that different text markup languages can change documents |
| 65 | | * using their respective syntax. |
| 66 | | */ |
| 67 | | public final class GuiCommands { |
| 68 | | private static final ExecutorService sExecutor = newFixedThreadPool( 1 ); |
| 69 | | |
| 70 | | private static final String STYLE_SEARCH = "search"; |
| 71 | | |
| 72 | | /** |
| 73 | | * Sci-fi genres, which are can be longer than other genres, typically fall |
| 74 | | * below 150,000 words at 6 chars per word. This reduces re-allocations of |
| 75 | | * memory when concatenating files together when exporting novels. |
| 76 | | */ |
| 77 | | private static final int DOCUMENT_LENGTH = 150_000 * 6; |
| 78 | | |
| 79 | | /** |
| 80 | | * When an action is executed, this is one of the recipients. |
| 81 | | */ |
| 82 | | private final MainPane mMainPane; |
| 83 | | |
| 84 | | private final MainScene mMainScene; |
| 85 | | |
| 86 | | private final LogView mLogView; |
| 87 | | |
| 88 | | /** |
| 89 | | * Tracks finding text in the active document. |
| 90 | | */ |
| 91 | | private final SearchModel mSearchModel; |
| 92 | | |
| 93 | | public GuiCommands( final MainScene scene, final MainPane pane ) { |
| 94 | | mMainScene = scene; |
| 95 | | mMainPane = pane; |
| 96 | | mLogView = new LogView(); |
| 97 | | mSearchModel = new SearchModel(); |
| 98 | | mSearchModel.matchOffsetProperty().addListener( ( c, o, n ) -> { |
| 99 | | final var editor = getActiveTextEditor(); |
| 100 | | |
| 101 | | // Clear highlighted areas before highlighting a new region. |
| 102 | | if( o != null ) { |
| 103 | | editor.unstylize( STYLE_SEARCH ); |
| 104 | | } |
| 105 | | |
| 106 | | if( n != null ) { |
| 107 | | editor.moveTo( n.getStart() ); |
| 108 | | editor.stylize( n, STYLE_SEARCH ); |
| 109 | | } |
| 110 | | } ); |
| 111 | | |
| 112 | | // When the active text editor changes ... |
| 113 | | mMainPane.textEditorProperty().addListener( |
| 114 | | ( c, o, n ) -> { |
| 115 | | // ... update the haystack. |
| 116 | | mSearchModel.search( getActiveTextEditor().getText() ); |
| 117 | | |
| 118 | | // ... update the status bar with the current caret position. |
| 119 | | if( n != null ) { |
| 120 | | CaretMovedEvent.fire( n.getCaret() ); |
| 121 | | } |
| 122 | | } |
| 123 | | ); |
| 124 | | } |
| 125 | | |
| 126 | | public void file_new() { |
| 127 | | getMainPane().newTextEditor(); |
| 128 | | } |
| 129 | | |
| 130 | | public void file_open() { |
| 131 | | pickFiles( FILE_OPEN_MULTIPLE ).ifPresent( l -> getMainPane().open( l ) ); |
| 132 | | } |
| 133 | | |
| 134 | | public void file_close() { |
| 135 | | getMainPane().close(); |
| 136 | | } |
| 137 | | |
| 138 | | public void file_close_all() { |
| 139 | | getMainPane().closeAll(); |
| 140 | | } |
| 141 | | |
| 142 | | public void file_save() { |
| 143 | | getMainPane().save(); |
| 144 | | } |
| 145 | | |
| 146 | | public void file_save_as() { |
| 147 | | pickFiles( FILE_SAVE_AS ).ifPresent( l -> getMainPane().saveAs( l ) ); |
| 148 | | } |
| 149 | | |
| 150 | | public void file_save_all() { |
| 151 | | getMainPane().saveAll(); |
| 152 | | } |
| 153 | | |
| 154 | | /** |
| 155 | | * Converts the actively edited file in the given file format. |
| 156 | | * |
| 157 | | * @param format The destination file format. |
| 158 | | */ |
| 159 | | private void file_export( final ExportFormat format ) { |
| 160 | | file_export( format, false ); |
| 161 | | } |
| 162 | | |
| 163 | | /** |
| 164 | | * Converts one or more files into the given file format. If {@code dir} |
| 165 | | * is set to true, this will first append all files in the same directory |
| 166 | | * as the actively edited file. |
| 167 | | * |
| 168 | | * @param format The destination file format. |
| 169 | | * @param dir Export all files in the actively edited file's directory. |
| 170 | | */ |
| 171 | | private void file_export( final ExportFormat format, final boolean dir ) { |
| 172 | | final var main = getMainPane(); |
| 173 | | final var editor = main.getTextEditor(); |
| 174 | | final var exported = getWorkspace().fileProperty( KEY_UI_RECENT_EXPORT ); |
| 175 | | final var filename = format.toExportFilename( editor.getPath() ); |
| 176 | | final var selection = pickFiles( |
| 177 | | Constants.PDF_DEFAULT.getName().equals( exported.get().getName() ) |
| 178 | | ? filename |
| 179 | | : exported.get(), FILE_EXPORT |
| 180 | | ); |
| 181 | | |
| 182 | | selection.ifPresent( ( files ) -> { |
| 183 | | editor.save(); |
| 184 | | |
| 185 | | final var file = files.get( 0 ); |
| 186 | | final var path = file.toPath(); |
| 187 | | final var document = dir ? append( editor ) : editor.getText(); |
| 188 | | final var context = main.createProcessorContext( path, format ); |
| 189 | | |
| 190 | | final var task = new Task<Path>() { |
| 191 | | @Override |
| 192 | | protected Path call() throws Exception { |
| 193 | | final var chain = createProcessors( context ); |
| 194 | | final var export = chain.apply( document ); |
| 195 | | |
| 196 | | // Processors can export binary files. In such cases, processors |
| 197 | | // return null to prevent further processing. |
| 198 | | return export == null ? null : writeString( path, export ); |
| 199 | | } |
| 200 | | }; |
| 201 | | |
| 202 | | task.setOnSucceeded( |
| 203 | | e -> { |
| 204 | | // Remember the exported file name for next time. |
| 205 | | exported.setValue( file ); |
| 206 | | |
| 207 | | final var result = task.getValue(); |
| 208 | | |
| 209 | | // Binary formats must notify users of success independently. |
| 210 | | if( result != null ) { |
| 211 | | clue( "Main.status.export.success", result ); |
| 212 | | } |
| 213 | | } |
| 214 | | ); |
| 215 | | |
| 216 | | task.setOnFailed( e -> { |
| 217 | | final var ex = task.getException(); |
| 218 | | clue( ex ); |
| 219 | | |
| 220 | | if( ex instanceof TypeNotPresentException ) { |
| 221 | | fireExportFailedEvent(); |
| 222 | | } |
| 223 | | } ); |
| 224 | | |
| 225 | | sExecutor.execute( task ); |
| 226 | | } ); |
| 227 | | } |
| 228 | | |
| 229 | | /** |
| 230 | | * @param dir {@code true} means to export all files in the active file |
| 231 | | * editor's directory; {@code false} means to export only the |
| 232 | | * actively edited file. |
| 233 | | */ |
| 234 | | private void file_export_pdf( final boolean dir ) { |
| 235 | | final var workspace = getWorkspace(); |
| 236 | | final var themes = workspace.getFile( KEY_TYPESET_CONTEXT_THEMES_PATH ); |
| 237 | | final var theme = workspace.stringProperty( |
| 238 | | KEY_TYPESET_CONTEXT_THEME_SELECTION ); |
| 239 | | |
| 240 | | if( Typesetter.canRun() ) { |
| 241 | | // If the typesetter is installed, allow the user to select a theme. If |
| 242 | | // the themes aren't installed, a status message will appear. |
| 243 | | if( ThemePicker.choose( themes, theme ) ) { |
| 244 | | file_export( APPLICATION_PDF, dir ); |
| 245 | | } |
| 246 | | } |
| 247 | | else { |
| 248 | | fireExportFailedEvent(); |
| 249 | | } |
| 250 | | } |
| 251 | | |
| 252 | | public void file_export_pdf() { |
| 253 | | file_export_pdf( false ); |
| 254 | | } |
| 255 | | |
| 256 | | public void file_export_pdf_dir() { |
| 257 | | file_export_pdf( true ); |
| 258 | | } |
| 259 | | |
| 260 | | public void file_export_html_svg() { |
| 261 | | file_export( HTML_TEX_SVG ); |
| 262 | | } |
| 263 | | |
| 264 | | public void file_export_html_tex() { |
| 265 | | file_export( HTML_TEX_DELIMITED ); |
| 266 | | } |
| 267 | | |
| 268 | | public void file_export_xhtml_tex() { |
| 269 | | file_export( XHTML_TEX ); |
| 270 | | } |
| 271 | | |
| 272 | | private void fireExportFailedEvent() { |
| 273 | | runLater( ExportFailedEvent::fire ); |
| 274 | | } |
| 275 | | |
| 276 | | public void file_exit() { |
| 277 | | final var window = getWindow(); |
| 278 | | fireEvent( window, new WindowEvent( window, WINDOW_CLOSE_REQUEST ) ); |
| 279 | | } |
| 280 | | |
| 281 | | public void edit_undo() { |
| 282 | | getActiveTextEditor().undo(); |
| 283 | | } |
| 284 | | |
| 285 | | public void edit_redo() { |
| 286 | | getActiveTextEditor().redo(); |
| 287 | | } |
| 288 | | |
| 289 | | public void edit_cut() { |
| 290 | | getActiveTextEditor().cut(); |
| 291 | | } |
| 292 | | |
| 293 | | public void edit_copy() { |
| 294 | | getActiveTextEditor().copy(); |
| 295 | | } |
| 296 | | |
| 297 | | public void edit_paste() { |
| 298 | | getActiveTextEditor().paste(); |
| 299 | | } |
| 300 | | |
| 301 | | public void edit_select_all() { |
| 302 | | getActiveTextEditor().selectAll(); |
| 303 | | } |
| 304 | | |
| 305 | | public void edit_find() { |
| 306 | | final var nodes = getMainScene().getStatusBar().getLeftItems(); |
| 307 | | |
| 308 | | if( nodes.isEmpty() ) { |
| 309 | | final var searchBar = new SearchBar(); |
| 310 | | |
| 311 | | searchBar.matchIndexProperty().bind( mSearchModel.matchIndexProperty() ); |
| 312 | | searchBar.matchCountProperty().bind( mSearchModel.matchCountProperty() ); |
| 313 | | |
| 314 | | searchBar.setOnCancelAction( ( event ) -> { |
| 315 | | final var editor = getActiveTextEditor(); |
| 316 | | nodes.remove( searchBar ); |
| 317 | | editor.unstylize( STYLE_SEARCH ); |
| 318 | | editor.getNode().requestFocus(); |
| 319 | | } ); |
| 320 | | |
| 321 | | searchBar.addInputListener( ( c, o, n ) -> { |
| 322 | | if( n != null && !n.isEmpty() ) { |
| 323 | | mSearchModel.search( n, getActiveTextEditor().getText() ); |
| 324 | | } |
| 325 | | } ); |
| 326 | | |
| 327 | | searchBar.setOnNextAction( ( event ) -> edit_find_next() ); |
| 328 | | searchBar.setOnPrevAction( ( event ) -> edit_find_prev() ); |
| 329 | | |
| 330 | | nodes.add( searchBar ); |
| 331 | | searchBar.requestFocus(); |
| 332 | | } |
| 333 | | else { |
| 334 | | nodes.clear(); |
| 335 | | } |
| 336 | | } |
| 337 | | |
| 338 | | public void edit_find_next() { |
| 339 | | mSearchModel.advance(); |
| 340 | | } |
| 341 | | |
| 342 | | public void edit_find_prev() { |
| 343 | | mSearchModel.retreat(); |
| 344 | | } |
| 345 | | |
| 346 | | public void edit_preferences() { |
| 347 | | try { |
| 348 | | new PreferencesController( getWorkspace() ).show(); |
| 349 | | } catch( final Exception ex ) { |
| 350 | | clue( ex ); |
| 351 | | } |
| 352 | | } |
| 353 | | |
| 354 | | public void format_bold() { |
| 355 | | getActiveTextEditor().bold(); |
| 356 | | } |
| 357 | | |
| 358 | | public void format_italic() { |
| 359 | | getActiveTextEditor().italic(); |
| 360 | | } |
| 361 | | |
| 362 | | public void format_monospace() { |
| 363 | | getActiveTextEditor().monospace(); |
| 364 | | } |
| 365 | | |
| 366 | | public void format_superscript() { |
| 367 | | getActiveTextEditor().superscript(); |
| 368 | | } |
| 369 | | |
| 370 | | public void format_subscript() { |
| 371 | | getActiveTextEditor().subscript(); |
| 372 | | } |
| 373 | | |
| 374 | | public void format_strikethrough() { |
| 375 | | getActiveTextEditor().strikethrough(); |
| 376 | | } |
| 377 | | |
| 378 | | public void insert_blockquote() { |
| 379 | | getActiveTextEditor().blockquote(); |
| 380 | | } |
| 381 | | |
| 382 | | public void insert_code() { |
| 383 | | getActiveTextEditor().code(); |
| 384 | | } |
| 385 | | |
| 386 | | public void insert_fenced_code_block() { |
| 387 | | getActiveTextEditor().fencedCodeBlock(); |
| 388 | | } |
| 389 | | |
| 390 | | public void insert_link() { |
| 391 | | insertObject( createLinkDialog() ); |
| 392 | | } |
| 393 | | |
| 394 | | public void insert_image() { |
| 395 | | insertObject( createImageDialog() ); |
| 396 | | } |
| 397 | | |
| 398 | | private void insertObject( final Dialog<String> dialog ) { |
| 399 | | final var textArea = getActiveTextEditor().getTextArea(); |
| 400 | | dialog.showAndWait().ifPresent( textArea::replaceSelection ); |
| 401 | | } |
| 402 | | |
| 403 | | private Dialog<String> createLinkDialog() { |
| 404 | | return new LinkDialog( getWindow(), createHyperlinkModel() ); |
| 405 | | } |
| 406 | | |
| 407 | | private Dialog<String> createImageDialog() { |
| 408 | | final var path = getActiveTextEditor().getPath(); |
| 409 | | final var parentDir = path.getParent(); |
| 410 | | return new ImageDialog( getWindow(), parentDir ); |
| 411 | | } |
| 412 | | |
| 413 | | /** |
| 414 | | * Returns one of: selected text, word under cursor, or parsed hyperlink from |
| 415 | | * the Markdown AST. |
| 416 | | * |
| 417 | | * @return An instance containing the link URL and display text. |
| 418 | | */ |
| 419 | | private HyperlinkModel createHyperlinkModel() { |
| 420 | | final var context = getMainPane().createProcessorContext(); |
| 421 | | final var editor = getActiveTextEditor(); |
| 422 | | final var textArea = editor.getTextArea(); |
| 423 | | final var selectedText = textArea.getSelectedText(); |
| 424 | | |
| 425 | | // Convert current paragraph to Markdown nodes. |
| 426 | | final var mp = MarkdownProcessor.create( context ); |
| 427 | | final var p = textArea.getCurrentParagraph(); |
| 428 | | final var paragraph = textArea.getText( p ); |
| 429 | | final var node = mp.toNode( paragraph ); |
| 430 | | final var visitor = new LinkVisitor( textArea.getCaretColumn() ); |
| 431 | | final var link = visitor.process( node ); |
| 432 | | |
| 433 | | if( link != null ) { |
| 434 | | textArea.selectRange( p, link.getStartOffset(), p, link.getEndOffset() ); |
| 435 | | } |
| 436 | | |
| 437 | | return createHyperlinkModel( link, selectedText ); |
| 438 | | } |
| 439 | | |
| 440 | | private HyperlinkModel createHyperlinkModel( |
| 441 | | final Link link, final String selection ) { |
| 442 | | |
| 443 | | return link == null |
| 444 | | ? new HyperlinkModel( selection, "https://localhost" ) |
| 445 | | : new HyperlinkModel( link ); |
| 446 | | } |
| 447 | | |
| 448 | | public void insert_heading_1() { |
| 449 | | insert_heading( 1 ); |
| 450 | | } |
| 451 | | |
| 452 | | public void insert_heading_2() { |
| 453 | | insert_heading( 2 ); |
| 454 | | } |
| 455 | | |
| 456 | | public void insert_heading_3() { |
| 457 | | insert_heading( 3 ); |
| 458 | | } |
| 459 | | |
| 460 | | private void insert_heading( final int level ) { |
| 461 | | getActiveTextEditor().heading( level ); |
| 462 | | } |
| 463 | | |
| 464 | | public void insert_unordered_list() { |
| 465 | | getActiveTextEditor().unorderedList(); |
| 466 | | } |
| 467 | | |
| 468 | | public void insert_ordered_list() { |
| 469 | | getActiveTextEditor().orderedList(); |
| 470 | | } |
| 471 | | |
| 472 | | public void insert_horizontal_rule() { |
| 473 | | getActiveTextEditor().horizontalRule(); |
| 474 | | } |
| 475 | | |
| 476 | | public void definition_create() { |
| 477 | | getActiveTextDefinition().createDefinition(); |
| 478 | | } |
| 479 | | |
| 480 | | public void definition_rename() { |
| 481 | | getActiveTextDefinition().renameDefinition(); |
| 482 | | } |
| 483 | | |
| 484 | | public void definition_delete() { |
| 485 | | getActiveTextDefinition().deleteDefinitions(); |
| 486 | | } |
| 487 | | |
| 488 | | public void definition_autoinsert() { |
| 489 | | getMainPane().autoinsert(); |
| 490 | | } |
| 491 | | |
| 492 | | public void view_refresh() { |
| 493 | | getMainPane().viewRefresh(); |
| 494 | | } |
| 495 | | |
| 496 | | public void view_preview() { |
| 497 | | getMainPane().viewPreview(); |
| 498 | | } |
| 499 | | |
| 500 | | public void view_outline() { |
| 501 | | getMainPane().viewOutline(); |
| 502 | | } |
| 503 | | |
| 504 | | public void view_files() {getMainPane().viewFiles();} |
| 505 | | |
| 506 | | public void view_statistics() { |
| 507 | | getMainPane().viewStatistics(); |
| 508 | | } |
| 509 | | |
| 510 | | public void view_menubar() { |
| 511 | | getMainScene().toggleMenuBar(); |
| 512 | | } |
| 513 | | |
| 514 | | public void view_toolbar() { |
| 515 | | getMainScene().toggleToolBar(); |
| 516 | | } |
| 517 | | |
| 518 | | public void view_statusbar() { |
| 519 | | getMainScene().toggleStatusBar(); |
| 520 | | } |
| 521 | | |
| 522 | | public void view_log() { |
| 523 | | mLogView.view(); |
| 524 | | } |
| 525 | | |
| 526 | | public void help_about() { |
| 527 | | final var alert = new Alert( INFORMATION ); |
| 528 | | final var prefix = "Dialog.about."; |
| 529 | | alert.setTitle( get( prefix + "title", APP_TITLE ) ); |
| 530 | | alert.setHeaderText( get( prefix + "header", APP_TITLE ) ); |
| 531 | | alert.setContentText( get( prefix + "content", APP_YEAR, APP_VERSION ) ); |
| 532 | | alert.setGraphic( ICON_DIALOG_NODE ); |
| 533 | | alert.initOwner( getWindow() ); |
| 534 | | alert.showAndWait(); |
| 535 | | } |
| 536 | | |
| 537 | | /** |
| 538 | | * Concatenates all the files in the same directory as the given file into |
| 539 | | * a string. The extension is determined by the given file name pattern; the |
| 540 | | * order files are concatenated is based on their numeric sort order (this |
| 541 | | * avoids lexicographic sorting). |
| 542 | | * <p> |
| 543 | | * If the parent path to the file being edited in the text editor cannot |
| 544 | | * be found then this will return the editor's text, without iterating through |
| 545 | | * the parent directory. (Should never happen, but who knows?) |
| 546 | | * </p> |
| 547 | | * <p> |
| 548 | | * New lines are automatically appended to separate each file. |
| 549 | | * </p> |
| 550 | | * |
| 551 | | * @param editor The text editor containing |
| 552 | | * @return All files in the same directory as the file being edited |
| 553 | | * concatenated into a single string. |
| 554 | | */ |
| 555 | | private String append( final TextEditor editor ) { |
| 556 | | final var pattern = editor.getPath(); |
| 557 | | final var parent = pattern.getParent(); |
| 558 | | |
| 559 | | // Short-circuit because nothing else can be done. |
| 560 | | if( parent == null ) { |
| 561 | | clue( "Main.status.export.concat.parent", pattern ); |
| 562 | | return editor.getText(); |
| 563 | | } |
| 564 | | |
| 565 | | final var filename = pattern.getFileName().toString(); |
| 566 | | final var extension = getExtension( filename ); |
| 567 | | |
| 568 | | if( extension.isBlank() ) { |
| 569 | | clue( "Main.status.export.concat.extension", filename ); |
| 570 | | return editor.getText(); |
| 571 | | } |
| 572 | | |
| 573 | | try { |
| 574 | | final var glob = "**/*." + extension; |
| 575 | | final ArrayList<Path> files = new ArrayList<>(); |
| 576 | | walk( parent, glob, files::add ); |
| 577 | | files.sort( new AlphanumComparator<>() ); |
| 578 | | |
| 579 | | final var text = new StringBuilder( DOCUMENT_LENGTH ); |
| 580 | | |
| 581 | | files.forEach( file -> { |
| 582 | | try { |
| 583 | | clue( "Main.status.export.concat", file ); |
| 584 | | text.append( readString( file ) ); |
| 585 | | } catch( final IOException ex ) { |
| 586 | | clue( "Main.status.export.concat.io", file ); |
| 587 | | } |
| 588 | | } ); |
| 589 | | |
| 590 | | return text.toString(); |
| 591 | | } catch( final Throwable t ) { |
| 592 | | clue( t ); |
| 593 | | return editor.getText(); |
| 594 | | } |
| 595 | | } |
| 596 | | |
| 597 | | private Optional<List<File>> pickFiles( final Options... options ) { |
| 598 | | return createPicker( options ).choose(); |
| 599 | | } |
| 600 | | |
| 601 | | private Optional<List<File>> pickFiles( |
| 602 | | final File filename, final Options... options ) { |
| 603 | | final var picker = createPicker( options ); |
| 604 | | picker.setInitialFilename( filename ); |
| 605 | | return picker.choose(); |
| 606 | | } |
| 607 | | |
| 608 | | private FilePicker createPicker( final Options... options ) { |
| 609 | | final var factory = new FilePickerFactory( getWorkspace() ); |
| 610 | | return factory.createModal( getWindow(), options ); |
| 49 | import static com.keenwrite.ui.explorer.FilePickerFactory.SelectionType; |
| 50 | import static com.keenwrite.ui.explorer.FilePickerFactory.SelectionType.*; |
| 51 | import static com.keenwrite.util.FileWalker.walk; |
| 52 | import static java.nio.file.Files.readString; |
| 53 | import static java.nio.file.Files.writeString; |
| 54 | import static java.util.concurrent.Executors.newFixedThreadPool; |
| 55 | import static javafx.application.Platform.runLater; |
| 56 | import static javafx.event.Event.fireEvent; |
| 57 | import static javafx.scene.control.Alert.AlertType.INFORMATION; |
| 58 | import static javafx.stage.WindowEvent.WINDOW_CLOSE_REQUEST; |
| 59 | import static org.apache.commons.io.FilenameUtils.getExtension; |
| 60 | |
| 61 | /** |
| 62 | * Responsible for abstracting how functionality is mapped to the application. |
| 63 | * This allows users to customize accelerator keys and will provide pluggable |
| 64 | * functionality so that different text markup languages can change documents |
| 65 | * using their respective syntax. |
| 66 | */ |
| 67 | public final class GuiCommands { |
| 68 | private static final ExecutorService sExecutor = newFixedThreadPool( 1 ); |
| 69 | |
| 70 | private static final String STYLE_SEARCH = "search"; |
| 71 | |
| 72 | /** |
| 73 | * Sci-fi genres, which are can be longer than other genres, typically fall |
| 74 | * below 150,000 words at 6 chars per word. This reduces re-allocations of |
| 75 | * memory when concatenating files together when exporting novels. |
| 76 | */ |
| 77 | private static final int DOCUMENT_LENGTH = 150_000 * 6; |
| 78 | |
| 79 | /** |
| 80 | * When an action is executed, this is one of the recipients. |
| 81 | */ |
| 82 | private final MainPane mMainPane; |
| 83 | |
| 84 | private final MainScene mMainScene; |
| 85 | |
| 86 | private final LogView mLogView; |
| 87 | |
| 88 | /** |
| 89 | * Tracks finding text in the active document. |
| 90 | */ |
| 91 | private final SearchModel mSearchModel; |
| 92 | |
| 93 | public GuiCommands( final MainScene scene, final MainPane pane ) { |
| 94 | mMainScene = scene; |
| 95 | mMainPane = pane; |
| 96 | mLogView = new LogView(); |
| 97 | mSearchModel = new SearchModel(); |
| 98 | mSearchModel.matchOffsetProperty().addListener( ( c, o, n ) -> { |
| 99 | final var editor = getActiveTextEditor(); |
| 100 | |
| 101 | // Clear highlighted areas before highlighting a new region. |
| 102 | if( o != null ) { |
| 103 | editor.unstylize( STYLE_SEARCH ); |
| 104 | } |
| 105 | |
| 106 | if( n != null ) { |
| 107 | editor.moveTo( n.getStart() ); |
| 108 | editor.stylize( n, STYLE_SEARCH ); |
| 109 | } |
| 110 | } ); |
| 111 | |
| 112 | // When the active text editor changes ... |
| 113 | mMainPane.textEditorProperty().addListener( |
| 114 | ( c, o, n ) -> { |
| 115 | // ... update the haystack. |
| 116 | mSearchModel.search( getActiveTextEditor().getText() ); |
| 117 | |
| 118 | // ... update the status bar with the current caret position. |
| 119 | if( n != null ) { |
| 120 | CaretMovedEvent.fire( n.getCaret() ); |
| 121 | } |
| 122 | } |
| 123 | ); |
| 124 | } |
| 125 | |
| 126 | public void file_new() { |
| 127 | getMainPane().newTextEditor(); |
| 128 | } |
| 129 | |
| 130 | public void file_open() { |
| 131 | pickFiles( FILE_OPEN_MULTIPLE ).ifPresent( l -> getMainPane().open( l ) ); |
| 132 | } |
| 133 | |
| 134 | public void file_close() { |
| 135 | getMainPane().close(); |
| 136 | } |
| 137 | |
| 138 | public void file_close_all() { |
| 139 | getMainPane().closeAll(); |
| 140 | } |
| 141 | |
| 142 | public void file_save() { |
| 143 | getMainPane().save(); |
| 144 | } |
| 145 | |
| 146 | public void file_save_as() { |
| 147 | pickFiles( FILE_SAVE_AS ).ifPresent( l -> getMainPane().saveAs( l ) ); |
| 148 | } |
| 149 | |
| 150 | public void file_save_all() { |
| 151 | getMainPane().saveAll(); |
| 152 | } |
| 153 | |
| 154 | /** |
| 155 | * Converts the actively edited file in the given file format. |
| 156 | * |
| 157 | * @param format The destination file format. |
| 158 | */ |
| 159 | private void file_export( final ExportFormat format ) { |
| 160 | file_export( format, false ); |
| 161 | } |
| 162 | |
| 163 | /** |
| 164 | * Converts one or more files into the given file format. If {@code dir} |
| 165 | * is set to true, this will first append all files in the same directory |
| 166 | * as the actively edited file. |
| 167 | * |
| 168 | * @param format The destination file format. |
| 169 | * @param dir Export all files in the actively edited file's directory. |
| 170 | */ |
| 171 | private void file_export( final ExportFormat format, final boolean dir ) { |
| 172 | final var main = getMainPane(); |
| 173 | final var editor = main.getTextEditor(); |
| 174 | final var exported = getWorkspace().fileProperty( KEY_UI_RECENT_EXPORT ); |
| 175 | final var filename = format.toExportFilename( editor.getPath() ); |
| 176 | final var selection = pickFile( |
| 177 | Constants.PDF_DEFAULT.getName().equals( exported.get().getName() ) |
| 178 | ? filename |
| 179 | : exported.get(), FILE_EXPORT |
| 180 | ); |
| 181 | |
| 182 | selection.ifPresent( ( files ) -> { |
| 183 | editor.save(); |
| 184 | |
| 185 | final var file = files.get( 0 ); |
| 186 | final var path = file.toPath(); |
| 187 | final var document = dir ? append( editor ) : editor.getText(); |
| 188 | final var context = main.createProcessorContext( path, format ); |
| 189 | |
| 190 | final var task = new Task<Path>() { |
| 191 | @Override |
| 192 | protected Path call() throws Exception { |
| 193 | final var chain = createProcessors( context ); |
| 194 | final var export = chain.apply( document ); |
| 195 | |
| 196 | // Processors can export binary files. In such cases, processors |
| 197 | // return null to prevent further processing. |
| 198 | return export == null ? null : writeString( path, export ); |
| 199 | } |
| 200 | }; |
| 201 | |
| 202 | task.setOnSucceeded( |
| 203 | e -> { |
| 204 | // Remember the exported file name for next time. |
| 205 | exported.setValue( file ); |
| 206 | |
| 207 | final var result = task.getValue(); |
| 208 | |
| 209 | // Binary formats must notify users of success independently. |
| 210 | if( result != null ) { |
| 211 | clue( "Main.status.export.success", result ); |
| 212 | } |
| 213 | } |
| 214 | ); |
| 215 | |
| 216 | task.setOnFailed( e -> { |
| 217 | final var ex = task.getException(); |
| 218 | clue( ex ); |
| 219 | |
| 220 | if( ex instanceof TypeNotPresentException ) { |
| 221 | fireExportFailedEvent(); |
| 222 | } |
| 223 | } ); |
| 224 | |
| 225 | sExecutor.execute( task ); |
| 226 | } ); |
| 227 | } |
| 228 | |
| 229 | /** |
| 230 | * @param dir {@code true} means to export all files in the active file |
| 231 | * editor's directory; {@code false} means to export only the |
| 232 | * actively edited file. |
| 233 | */ |
| 234 | private void file_export_pdf( final boolean dir ) { |
| 235 | final var workspace = getWorkspace(); |
| 236 | final var themes = workspace.getFile( KEY_TYPESET_CONTEXT_THEMES_PATH ); |
| 237 | final var theme = workspace.stringProperty( |
| 238 | KEY_TYPESET_CONTEXT_THEME_SELECTION ); |
| 239 | |
| 240 | if( Typesetter.canRun() ) { |
| 241 | // If the typesetter is installed, allow the user to select a theme. If |
| 242 | // the themes aren't installed, a status message will appear. |
| 243 | if( ThemePicker.choose( themes, theme ) ) { |
| 244 | file_export( APPLICATION_PDF, dir ); |
| 245 | } |
| 246 | } |
| 247 | else { |
| 248 | fireExportFailedEvent(); |
| 249 | } |
| 250 | } |
| 251 | |
| 252 | public void file_export_pdf() { |
| 253 | file_export_pdf( false ); |
| 254 | } |
| 255 | |
| 256 | public void file_export_pdf_dir() { |
| 257 | file_export_pdf( true ); |
| 258 | } |
| 259 | |
| 260 | public void file_export_html_svg() { |
| 261 | file_export( HTML_TEX_SVG ); |
| 262 | } |
| 263 | |
| 264 | public void file_export_html_tex() { |
| 265 | file_export( HTML_TEX_DELIMITED ); |
| 266 | } |
| 267 | |
| 268 | public void file_export_xhtml_tex() { |
| 269 | file_export( XHTML_TEX ); |
| 270 | } |
| 271 | |
| 272 | private void fireExportFailedEvent() { |
| 273 | runLater( ExportFailedEvent::fire ); |
| 274 | } |
| 275 | |
| 276 | public void file_exit() { |
| 277 | final var window = getWindow(); |
| 278 | fireEvent( window, new WindowEvent( window, WINDOW_CLOSE_REQUEST ) ); |
| 279 | } |
| 280 | |
| 281 | public void edit_undo() { |
| 282 | getActiveTextEditor().undo(); |
| 283 | } |
| 284 | |
| 285 | public void edit_redo() { |
| 286 | getActiveTextEditor().redo(); |
| 287 | } |
| 288 | |
| 289 | public void edit_cut() { |
| 290 | getActiveTextEditor().cut(); |
| 291 | } |
| 292 | |
| 293 | public void edit_copy() { |
| 294 | getActiveTextEditor().copy(); |
| 295 | } |
| 296 | |
| 297 | public void edit_paste() { |
| 298 | getActiveTextEditor().paste(); |
| 299 | } |
| 300 | |
| 301 | public void edit_select_all() { |
| 302 | getActiveTextEditor().selectAll(); |
| 303 | } |
| 304 | |
| 305 | public void edit_find() { |
| 306 | final var nodes = getMainScene().getStatusBar().getLeftItems(); |
| 307 | |
| 308 | if( nodes.isEmpty() ) { |
| 309 | final var searchBar = new SearchBar(); |
| 310 | |
| 311 | searchBar.matchIndexProperty().bind( mSearchModel.matchIndexProperty() ); |
| 312 | searchBar.matchCountProperty().bind( mSearchModel.matchCountProperty() ); |
| 313 | |
| 314 | searchBar.setOnCancelAction( ( event ) -> { |
| 315 | final var editor = getActiveTextEditor(); |
| 316 | nodes.remove( searchBar ); |
| 317 | editor.unstylize( STYLE_SEARCH ); |
| 318 | editor.getNode().requestFocus(); |
| 319 | } ); |
| 320 | |
| 321 | searchBar.addInputListener( ( c, o, n ) -> { |
| 322 | if( n != null && !n.isEmpty() ) { |
| 323 | mSearchModel.search( n, getActiveTextEditor().getText() ); |
| 324 | } |
| 325 | } ); |
| 326 | |
| 327 | searchBar.setOnNextAction( ( event ) -> edit_find_next() ); |
| 328 | searchBar.setOnPrevAction( ( event ) -> edit_find_prev() ); |
| 329 | |
| 330 | nodes.add( searchBar ); |
| 331 | searchBar.requestFocus(); |
| 332 | } |
| 333 | else { |
| 334 | nodes.clear(); |
| 335 | } |
| 336 | } |
| 337 | |
| 338 | public void edit_find_next() { |
| 339 | mSearchModel.advance(); |
| 340 | } |
| 341 | |
| 342 | public void edit_find_prev() { |
| 343 | mSearchModel.retreat(); |
| 344 | } |
| 345 | |
| 346 | public void edit_preferences() { |
| 347 | try { |
| 348 | new PreferencesController( getWorkspace() ).show(); |
| 349 | } catch( final Exception ex ) { |
| 350 | clue( ex ); |
| 351 | } |
| 352 | } |
| 353 | |
| 354 | public void format_bold() { |
| 355 | getActiveTextEditor().bold(); |
| 356 | } |
| 357 | |
| 358 | public void format_italic() { |
| 359 | getActiveTextEditor().italic(); |
| 360 | } |
| 361 | |
| 362 | public void format_monospace() { |
| 363 | getActiveTextEditor().monospace(); |
| 364 | } |
| 365 | |
| 366 | public void format_superscript() { |
| 367 | getActiveTextEditor().superscript(); |
| 368 | } |
| 369 | |
| 370 | public void format_subscript() { |
| 371 | getActiveTextEditor().subscript(); |
| 372 | } |
| 373 | |
| 374 | public void format_strikethrough() { |
| 375 | getActiveTextEditor().strikethrough(); |
| 376 | } |
| 377 | |
| 378 | public void insert_blockquote() { |
| 379 | getActiveTextEditor().blockquote(); |
| 380 | } |
| 381 | |
| 382 | public void insert_code() { |
| 383 | getActiveTextEditor().code(); |
| 384 | } |
| 385 | |
| 386 | public void insert_fenced_code_block() { |
| 387 | getActiveTextEditor().fencedCodeBlock(); |
| 388 | } |
| 389 | |
| 390 | public void insert_link() { |
| 391 | insertObject( createLinkDialog() ); |
| 392 | } |
| 393 | |
| 394 | public void insert_image() { |
| 395 | insertObject( createImageDialog() ); |
| 396 | } |
| 397 | |
| 398 | private void insertObject( final Dialog<String> dialog ) { |
| 399 | final var textArea = getActiveTextEditor().getTextArea(); |
| 400 | dialog.showAndWait().ifPresent( textArea::replaceSelection ); |
| 401 | } |
| 402 | |
| 403 | private Dialog<String> createLinkDialog() { |
| 404 | return new LinkDialog( getWindow(), createHyperlinkModel() ); |
| 405 | } |
| 406 | |
| 407 | private Dialog<String> createImageDialog() { |
| 408 | final var path = getActiveTextEditor().getPath(); |
| 409 | final var parentDir = path.getParent(); |
| 410 | return new ImageDialog( getWindow(), parentDir ); |
| 411 | } |
| 412 | |
| 413 | /** |
| 414 | * Returns one of: selected text, word under cursor, or parsed hyperlink from |
| 415 | * the Markdown AST. |
| 416 | * |
| 417 | * @return An instance containing the link URL and display text. |
| 418 | */ |
| 419 | private HyperlinkModel createHyperlinkModel() { |
| 420 | final var context = getMainPane().createProcessorContext(); |
| 421 | final var editor = getActiveTextEditor(); |
| 422 | final var textArea = editor.getTextArea(); |
| 423 | final var selectedText = textArea.getSelectedText(); |
| 424 | |
| 425 | // Convert current paragraph to Markdown nodes. |
| 426 | final var mp = MarkdownProcessor.create( context ); |
| 427 | final var p = textArea.getCurrentParagraph(); |
| 428 | final var paragraph = textArea.getText( p ); |
| 429 | final var node = mp.toNode( paragraph ); |
| 430 | final var visitor = new LinkVisitor( textArea.getCaretColumn() ); |
| 431 | final var link = visitor.process( node ); |
| 432 | |
| 433 | if( link != null ) { |
| 434 | textArea.selectRange( p, link.getStartOffset(), p, link.getEndOffset() ); |
| 435 | } |
| 436 | |
| 437 | return createHyperlinkModel( link, selectedText ); |
| 438 | } |
| 439 | |
| 440 | private HyperlinkModel createHyperlinkModel( |
| 441 | final Link link, final String selection ) { |
| 442 | |
| 443 | return link == null |
| 444 | ? new HyperlinkModel( selection, "https://localhost" ) |
| 445 | : new HyperlinkModel( link ); |
| 446 | } |
| 447 | |
| 448 | public void insert_heading_1() { |
| 449 | insert_heading( 1 ); |
| 450 | } |
| 451 | |
| 452 | public void insert_heading_2() { |
| 453 | insert_heading( 2 ); |
| 454 | } |
| 455 | |
| 456 | public void insert_heading_3() { |
| 457 | insert_heading( 3 ); |
| 458 | } |
| 459 | |
| 460 | private void insert_heading( final int level ) { |
| 461 | getActiveTextEditor().heading( level ); |
| 462 | } |
| 463 | |
| 464 | public void insert_unordered_list() { |
| 465 | getActiveTextEditor().unorderedList(); |
| 466 | } |
| 467 | |
| 468 | public void insert_ordered_list() { |
| 469 | getActiveTextEditor().orderedList(); |
| 470 | } |
| 471 | |
| 472 | public void insert_horizontal_rule() { |
| 473 | getActiveTextEditor().horizontalRule(); |
| 474 | } |
| 475 | |
| 476 | public void definition_create() { |
| 477 | getActiveTextDefinition().createDefinition(); |
| 478 | } |
| 479 | |
| 480 | public void definition_rename() { |
| 481 | getActiveTextDefinition().renameDefinition(); |
| 482 | } |
| 483 | |
| 484 | public void definition_delete() { |
| 485 | getActiveTextDefinition().deleteDefinitions(); |
| 486 | } |
| 487 | |
| 488 | public void definition_autoinsert() { |
| 489 | getMainPane().autoinsert(); |
| 490 | } |
| 491 | |
| 492 | public void view_refresh() { |
| 493 | getMainPane().viewRefresh(); |
| 494 | } |
| 495 | |
| 496 | public void view_preview() { |
| 497 | getMainPane().viewPreview(); |
| 498 | } |
| 499 | |
| 500 | public void view_outline() { |
| 501 | getMainPane().viewOutline(); |
| 502 | } |
| 503 | |
| 504 | public void view_files() {getMainPane().viewFiles();} |
| 505 | |
| 506 | public void view_statistics() { |
| 507 | getMainPane().viewStatistics(); |
| 508 | } |
| 509 | |
| 510 | public void view_menubar() { |
| 511 | getMainScene().toggleMenuBar(); |
| 512 | } |
| 513 | |
| 514 | public void view_toolbar() { |
| 515 | getMainScene().toggleToolBar(); |
| 516 | } |
| 517 | |
| 518 | public void view_statusbar() { |
| 519 | getMainScene().toggleStatusBar(); |
| 520 | } |
| 521 | |
| 522 | public void view_log() { |
| 523 | mLogView.view(); |
| 524 | } |
| 525 | |
| 526 | public void help_about() { |
| 527 | final var alert = new Alert( INFORMATION ); |
| 528 | final var prefix = "Dialog.about."; |
| 529 | alert.setTitle( get( prefix + "title", APP_TITLE ) ); |
| 530 | alert.setHeaderText( get( prefix + "header", APP_TITLE ) ); |
| 531 | alert.setContentText( get( prefix + "content", APP_YEAR, APP_VERSION ) ); |
| 532 | alert.setGraphic( ICON_DIALOG_NODE ); |
| 533 | alert.initOwner( getWindow() ); |
| 534 | alert.showAndWait(); |
| 535 | } |
| 536 | |
| 537 | /** |
| 538 | * Concatenates all the files in the same directory as the given file into |
| 539 | * a string. The extension is determined by the given file name pattern; the |
| 540 | * order files are concatenated is based on their numeric sort order (this |
| 541 | * avoids lexicographic sorting). |
| 542 | * <p> |
| 543 | * If the parent path to the file being edited in the text editor cannot |
| 544 | * be found then this will return the editor's text, without iterating through |
| 545 | * the parent directory. (Should never happen, but who knows?) |
| 546 | * </p> |
| 547 | * <p> |
| 548 | * New lines are automatically appended to separate each file. |
| 549 | * </p> |
| 550 | * |
| 551 | * @param editor The text editor containing |
| 552 | * @return All files in the same directory as the file being edited |
| 553 | * concatenated into a single string. |
| 554 | */ |
| 555 | private String append( final TextEditor editor ) { |
| 556 | final var pattern = editor.getPath(); |
| 557 | final var parent = pattern.getParent(); |
| 558 | |
| 559 | // Short-circuit because nothing else can be done. |
| 560 | if( parent == null ) { |
| 561 | clue( "Main.status.export.concat.parent", pattern ); |
| 562 | return editor.getText(); |
| 563 | } |
| 564 | |
| 565 | final var filename = pattern.getFileName().toString(); |
| 566 | final var extension = getExtension( filename ); |
| 567 | |
| 568 | if( extension.isBlank() ) { |
| 569 | clue( "Main.status.export.concat.extension", filename ); |
| 570 | return editor.getText(); |
| 571 | } |
| 572 | |
| 573 | try { |
| 574 | final var glob = "**/*." + extension; |
| 575 | final ArrayList<Path> files = new ArrayList<>(); |
| 576 | walk( parent, glob, files::add ); |
| 577 | files.sort( new AlphanumComparator<>() ); |
| 578 | |
| 579 | final var text = new StringBuilder( DOCUMENT_LENGTH ); |
| 580 | |
| 581 | files.forEach( file -> { |
| 582 | try { |
| 583 | clue( "Main.status.export.concat", file ); |
| 584 | text.append( readString( file ) ); |
| 585 | } catch( final IOException ex ) { |
| 586 | clue( "Main.status.export.concat.io", file ); |
| 587 | } |
| 588 | } ); |
| 589 | |
| 590 | return text.toString(); |
| 591 | } catch( final Throwable t ) { |
| 592 | clue( t ); |
| 593 | return editor.getText(); |
| 594 | } |
| 595 | } |
| 596 | |
| 597 | private Optional<List<File>> pickFiles( final SelectionType type ) { |
| 598 | return createPicker( type ).choose(); |
| 599 | } |
| 600 | |
| 601 | @SuppressWarnings( "SameParameterValue" ) |
| 602 | private Optional<List<File>> pickFile( |
| 603 | final File filename, final SelectionType type ) { |
| 604 | final var picker = createPicker( type ); |
| 605 | picker.setInitialFilename( filename ); |
| 606 | return picker.choose(); |
| 607 | } |
| 608 | |
| 609 | private FilePicker createPicker( final SelectionType type ) { |
| 610 | final var factory = new FilePickerFactory( getWorkspace() ); |
| 611 | return factory.createModal( getWindow(), type ); |
| 611 | 612 | } |
| 612 | 613 | |