private final Editor editor;

private final Mode mode;

/** main pde file for this sketch. */

private File mainFile;

/**

private String name;

/** true if any of the files have been modified. */

private boolean modified;

/** folder that contains this sketch */

private File folder;

/** data folder location for this sketch (may not exist yet) */

private File dataFolder;

/** code folder location for this sketch (may not exist yet) */

private File codeFolder;

private SketchCode current;

private int currentIndex;

/**

private int codeCount;

private SketchCode[] code;

/** Moved out of Editor and into here for cleaner access. */

private boolean untitled;

/** true if we've posted a "sketch disappeared" warning */

private boolean disappearedWarning;

/**

public Sketch(String path, Mode mode) {

this.editor = null;

this.mode = mode;

load(path);

}

/**

public Sketch(String path, Editor editor) throws IOException {

this.editor = editor;

this.mode = editor.getMode();

load(path);

}

protected void load(String path) {

mainFile = new File(path);

folder = mainFile.getParentFile();

/*

// starting in 4.0 beta 6, use the folder name instead of the main tab

name = folder.getName();

disappearedWarning = false;

load();

}

/**

protected void load() {

codeFolder = new File(folder, "code");

dataFolder = new File(folder, "data");

List<String> filenames = new ArrayList<>();

List<String> extensions = new ArrayList<>();

getSketchCodeFiles(filenames, extensions);

codeCount = filenames.size();

code = new SketchCode[codeCount];

for (int i = 0; i < codeCount; i++) {

String filename = filenames.get(i);

String extension = extensions.get(i);

code[i] = new SketchCode(new File(folder, filename), extension);

}

// move the main class to the first tab

// start at 1, if it's at zero, don't bother

for (int i = 1; i < codeCount; i++) {

//if (code[i].file.getName().equals(mainFilename)) {

if (code[i].getFile().equals(mainFile)) {

SketchCode temp = code[0];

code[0] = code[i];

code[i] = temp;

break;

}

}

// sort the entries at the top

sortCode();

// set the main file to be the current tab

if (editor != null) {

setCurrentCode(0);

}

}

public void getSketchCodeFiles(List<String> outFilenames,

List<String> outExtensions) {

// get list of files in the sketch folder

String[] list = folder.list();

if (list != null) {

for (String filename : list) {

// Ignoring the dot prefix files is especially important to avoid files

// with the ._ prefix on Mac OS X. (You'll see this with Mac files on

// non-HFS drives, i.e. a thumb drive formatted FAT32.)

if (filename.startsWith(".")) continue;

// Don't let some wacko name a directory blah.pde or bling.java.

if (new File(folder, filename).isDirectory()) continue;

// figure out the name without any extension

String base = filename;

// now strip off the .pde and .java extensions

for (String extension : mode.getExtensions()) {

if (base.toLowerCase().endsWith("." + extension)) {

base = base.substring(0, base.length() - (extension.length() + 1));

// Don't allow people to use files with invalid names, since on load,

// it would be otherwise possible to sneak in nasty filenames. [0116]

if (isSanitaryName(base)) {

if (outFilenames != null) outFilenames.add(filename);

if (outExtensions != null) outExtensions.add(extension);

}

}

}

}

}

}

/**

public void reload() {

// set current to null so that the tab gets updated

// https://download.processing.org/bugzilla/515.html

current = null;

// nuke previous files and settings

load();

}

/**

public void loadNewTab(String filename, String ext, boolean newAddition) {

if (newAddition) {

insertCode(new SketchCode(new File(folder, filename), ext));

} else {

replaceCode(new SketchCode(new File(folder, filename), ext));

}

sortCode();

}

protected void replaceCode(SketchCode newCode) {

for (int i = 0; i < codeCount; i++) {

if (code[i].getFileName().equals(newCode.getFileName())) {

code[i] = newCode;

break;

}

}

}

protected void insertCode(SketchCode newCode) {

// make sure the user didn't hide the sketch folder

ensureExistence();

// add file to the code/codeCount list, resort the list

//if (codeCount == code.length) {

code = (SketchCode[]) PApplet.append(code, newCode);

codeCount++;

//}

//code[codeCount++] = newCode;

}

protected void sortCode() {

// cheap-ass sort of the rest of the files

// it's a dumb, slow sort, but there shouldn't be more than ~5 files

for (int i = 1; i < codeCount; i++) {

int who = i;

for (int j = i + 1; j < codeCount; j++) {

if (code[j].getFileName().compareTo(code[who].getFileName()) < 0) {

who = j; // this guy is earlier in the alphabet

}

}

if (who != i) { // swap with someone if changes made

SketchCode temp = code[who];

code[who] = code[i];

code[i] = temp;

// We also need to update the current tab

if (currentIndex == i) {

currentIndex = who;

} else if (currentIndex == who) {

currentIndex = i;

}

}

}

}

boolean renamingCode;

/**

public void handleNewCode() {

// make sure the user didn't hide the sketch folder

ensureExistence();

// if read-only, give an error

if (isReadOnly()) {

// if the files are read-only, need to first do a "save as".

Messages.showMessage(Language.text("new.messages.is_read_only"),

Language.text("new.messages.is_read_only.description"));

return;

}

renamingCode = false;

// editor.status.edit("Name for new file:", "");

promptForTabName(Language.text("editor.tab.rename.description")+":", "");

}

/**

public void handleRenameCode() {

// make sure the user didn't hide the sketch folder

ensureExistence();

if (currentIndex == 0 && isUntitled()) {

Messages.showMessage(Language.text("rename.messages.is_untitled"),

Language.text("rename.messages.is_untitled.description"));

return;

}

if (isModified()) {

Messages.showMessage(Language.text("menu.file.save"),

Language.text("rename.messages.is_modified"));

return;

}

// if read-only, give an error

if (isReadOnly()) {

// if the files are read-only, need to first do a "save as".

Messages.showMessage(Language.text("rename.messages.is_read_only"),

Language.text("rename.messages.is_read_only.description"));

return;

}

// ask for new name of file (internal to window)

// TODO maybe just pop up a text area?

renamingCode = true;

String prompt = (currentIndex == 0 && Preferences.getBoolean("editor.sync_folder_and_filename")) ?

Language.text("editor.sketch.rename.description") :

Language.text("editor.tab.rename.description");

String oldName = (current.isExtension(mode.getDefaultExtension())) ?

current.getPrettyName() : current.getFileName();

promptForTabName(prompt + ":", oldName);

}

/**

protected void promptForTabName(String prompt, String oldName) {

final JTextField field = new JTextField(oldName);

field.addKeyListener(new KeyAdapter() {

// Forget ESC, the JDialog should handle it.

// Use keyTyped to catch when the feller is actually added to the text

// field. With keyTyped, as opposed to keyPressed, the keyCode will be

// zero, even if it's enter or backspace or whatever, so the key char

// should be used instead. Grr.

public void keyTyped(KeyEvent event) {

//System.out.println("got event " + event);

char ch = event.getKeyChar();

//noinspection StatementWithEmptyBody

if ((ch == '_') || (ch == '.') || // allow.pde and .java

(('A' <= ch) && (ch <= 'Z')) || (('a' <= ch) && (ch <= 'z'))) {

// These events are allowed straight through.

} else if (ch == ' ') {

String t = field.getText();

int start = field.getSelectionStart();

int end = field.getSelectionEnd();

field.setText(t.substring(0, start) + "_" + t.substring(end));

field.setCaretPosition(start + 1);

event.consume();

} else if ((ch >= '0') && (ch <= '9')) {

// getCaretPosition == 0 means that it's the first char

// and the field is empty.

// getSelectionStart means that it *will be* the first

// char, because the selection is about to be replaced

// with whatever is typed.

if (field.getCaretPosition() == 0 ||

field.getSelectionStart() == 0) {

// number not allowed as first digit

event.consume();

}

} else if (ch == KeyEvent.VK_ENTER) {

// Slightly ugly hack that ensures OK button of the dialog consumes

// the Enter key event. Since the text field is the default component

// in the dialog, OK doesn't consume Enter key event, by default.

Container parent = field.getParent();

while (!(parent instanceof JOptionPane pane)) {

parent = parent.getParent();

}

final JPanel pnlBottom = (JPanel)

pane.getComponent(pane.getComponentCount() - 1);

for (int i = 0; i < pnlBottom.getComponents().length; i++) {

Component component = pnlBottom.getComponents()[i];

if (component instanceof final JButton okButton) {

if (okButton.getText().equalsIgnoreCase("OK")) {

ActionListener[] actionListeners =

okButton.getActionListeners();

if (actionListeners.length > 0) {

actionListeners[0].actionPerformed(null);

event.consume();

}

}

}

}

} else {

event.consume();

}

}

});

int userReply = JOptionPane.showOptionDialog(editor, new Object[] {

prompt, field },

Language.text("editor.tab.new"),

JOptionPane.OK_CANCEL_OPTION,

JOptionPane.PLAIN_MESSAGE,

null, new Object[] {

Language.getPrompt("ok"),

Language.getPrompt("cancel") },

field);

if (userReply == JOptionPane.OK_OPTION) {

nameCode(field.getText());

}

}

/**

protected void nameCode(String newName) {

newName = newName.trim();

if (newName.length() == 0) {

return;

}

// Make sure the sketch folder is still available and exists.

ensureExistence();

// Add the extension here, this simplifies some logic below.

if (newName.indexOf('.') == -1) {

newName += "." + (renamingCode ? mode.getDefaultExtension() : mode.getModuleExtension());

}

// If renaming to the same thing as before, just ignore.

// Also ignoring case here, because I don't want to write/maintain/debug

// a bunch of platform-specific quirks: macOS is case-insensitive but

// preserving, Windows is insensitive, *nix is sensitive and preserving,

// and someday we're all gonna die, and I'm comfortable that writing the

// necessary code is not essential to the story of my life on Earth.

if (renamingCode) {

if (newName.equalsIgnoreCase(current.getFileName())) {

// exit quietly for the 'rename' case.

// if it's a 'new' then an error will occur down below

return;

}

}

if (newName.startsWith(".")) {

Messages.showWarning(Language.text("name.messages.problem_renaming"),

Language.text("name.messages.starts_with_dot.description"));

return;

}

int dot = newName.lastIndexOf('.');

String newExtension = newName.substring(dot+1).toLowerCase();

if (!mode.validExtension(newExtension)) {

Messages.showWarning(Language.text("name.messages.problem_renaming"),

Language.interpolate("name.messages.invalid_extension.description",

newExtension));

return;

}

// Don't let the user create the main tab as a .java file instead of .pde

if (!mode.isDefaultExtension(newExtension)) {

if (renamingCode) { // If creating a new tab, don't show this error

if (current == code[0]) { // If this is the main tab, disallow

Messages.showWarning(Language.text("name.messages.problem_renaming"),

Language.interpolate("name.messages.main_java_extension.description",

newExtension));

return;

}

}

}

// Dots are allowed for the .pde and .java, but not in the name.

// Make sure the user didn't name the file poo.time.pde or anything

// else with a dot inside it (nothing against poo time).

String shortName = newName.substring(0, dot);

String sanitaryName = Sketch.sanitizeName(shortName);

if (!shortName.equals(sanitaryName)) {

newName = sanitaryName + "." + newExtension;

}

// If changing the extension of a file from .pde to .java, then it's ok.

// https://github.com/processing/processing/issues/814

// (That regression was introduced years earlier by the bug report below.)

if (!(renamingCode && sanitaryName.equals(current.getPrettyName()))) {

// Make sure no .pde *and* no .java files with the same name already exist

// (other than the one we are currently attempting to rename)

// http://processing.org/bugs/bugzilla/543.html

for (SketchCode c : code) {

if (c != current && sanitaryName.equalsIgnoreCase(c.getPrettyName())) {

Messages.showMessage(Language.text("name.messages.new_sketch_exists"),

Language.interpolate("name.messages.new_sketch_exists.description",

c.getFileName(), folder.getAbsolutePath()));

return;

}

}

}

File newFile = new File(folder, newName);

if (renamingCode) {

if (currentIndex == 0 &&

Preferences.getBoolean("editor.sync_folder_and_filename")) {

if (!renameSketch(newName, newExtension)) return;

} else { // else if something besides code[0], or ok to decouple name

if (!current.renameTo(newFile, newExtension)) {

Messages.showWarning(Language.text("name.messages.error"),

Language.interpolate("name.messages.no_rename_file.description",

current.getFileName(), newFile.getName()));

return;

}

if (currentIndex == 0) {

// If the main tab was renamed, check sketch.properties

mainFile = newFile; //code[0].getFile();

updateNameProperties();

}

}

} else { // not renaming, creating a new file

try {

if (!newFile.createNewFile()) {

// Already checking for IOException, so make our own.

throw new IOException("createNewFile() returned false");

}

} catch (IOException e) {

Messages.showWarning(Language.text("name.messages.error"),

Language.interpolate("name.messages.no_create_file.description",

newFile, folder.getAbsolutePath()), e);

return;

}

SketchCode newCode = new SketchCode(newFile, newExtension);

insertCode(newCode);

}

// sort the entries

sortCode();

// set the new guy as current

setCurrentCode(newName);

// update the tabs

editor.rebuildHeader();

}

/**

protected boolean renameSketch(String newName, String newExtension) {

// get the new folder name/location

String folderName = newName.substring(0, newName.indexOf('.'));

File newFolder = new File(folder.getParentFile(), folderName);

if (newFolder.exists()) {

Messages.showWarning(Language.text("name.messages.new_folder_exists"),

Language.interpolate("name.messages.new_folder_exists.description", newName));

return false;

}

// renaming the containing sketch folder

boolean success = folder.renameTo(newFolder);

if (!success) {

Messages.showWarning(Language.text("name.messages.error"),

Language.text("name.messages.no_rename_folder.description"));

return false;

}

// let this guy know where he's living (at least for a split second)

current.setFolder(newFolder);

// folder will be set to newFolder by updateInternal()

// unfortunately this can't be a "save as" because that

// only copies the sketch files and the data folder

// however this *will* first save the sketch, then rename

// This isn't changing folders, just changes the name

File newFile = new File(newFolder, newName);

if (!current.renameTo(newFile, newExtension)) {

Messages.showWarning(Language.text("name.messages.error"),

Language.interpolate("name.messages.no_rename_file.description",

current.getFileName(), newFile.getName()));

return false;

}

// Tell each code file the good news about their new home.

// current.renameTo() above already took care of the main tab.

for (int i = 1; i < codeCount; i++) {

code[i].setFolder(newFolder);

}

// Save the path in case we need to remove it from the Recent menu

String oldPath = getMainPath();

// Update internal state to reflect the new location

updateInternal(newFolder);

if (renamingCode) {

// Update the Recent menu if a Rename event (but not Save As)

// https://github.com/processing/processing/issues/5902

Recent.rename(editor, oldPath);

}

return true;

}

/**

public void handleDeleteCode() {

// make sure the user didn't hide the sketch folder

ensureExistence();

// if read-only, give an error

if (isReadOnly()) {

// if the files are read-only, need to first do a "save as".

Messages.showMessage(Language.text("delete.messages.is_read_only"),

Language.text("delete.messages.is_read_only.description"));

return;

}

// don't allow if untitled

if (currentIndex == 0 && isUntitled()) {

Messages.showMessage(Language.text("delete.messages.cannot_delete"),

Language.text("delete.messages.cannot_delete.description"));

return;

}

if(currentIndex == 0){

Object[] options = { Language.text("menu.sketch.show_sketch_folder"), Language.text("prompt.cancel") };

int result = JOptionPane.showOptionDialog(editor,

Language.interpolate("warn.delete.sketch_last", getName()),

Language.text("warn.delete"),

JOptionPane.YES_NO_OPTION,

JOptionPane.ERROR_MESSAGE,

null,

options,

options[1]);

if (result == JOptionPane.YES_OPTION) {

Platform.openFolder(folder);

}

return;

}

// confirm deletion with user, yes/no

Object[] options = { Language.text("prompt.ok"), Language.text("prompt.cancel") };

String prompt = Language.interpolate("warn.delete.sketch_file", current.getPrettyName());

int result = JOptionPane.showOptionDialog(editor,

prompt,

Language.text("warn.delete"),

JOptionPane.YES_NO_OPTION,

JOptionPane.QUESTION_MESSAGE,

null,

options,

options[0]);

// TODO: Remove the code to remove the entire sketch folder

if (result == JOptionPane.YES_OPTION) {

if (currentIndex == 0) { // delete the entire sketch

// need to unset all the modified flags, otherwise tries

// to do a save on the handleNew()

// Attempt to move to the trash (falls back to removeDir)

try {

Platform.deleteFile(folder);

} catch (IOException e) {

e.printStackTrace();

}

// make a new sketch and rebuild the sketch menu

editor.getBase().rebuildSketchbook();

editor.getBase().handleClose(editor, false);

} else { // delete a single tab

if (!current.deleteFile()) {

Messages.showMessage(Language.text("delete.messages.cannot_delete.file"),

Language.text("delete.messages.cannot_delete.file.description")+" \"" +

current.getFileName() + "\".");

return;

}

// remove code from the list

removeCode(current);

// update the tabs

editor.rebuildHeader();

// just set current tab to the main tab

setCurrentCode(0);

}

}

}

/**

public void removeCode(SketchCode which) {

// remove it from the internal list of files

// resort internal list of files

for (int i = 0; i < codeCount; i++) {

if (code[i] == which) {

for (int j = i; j < codeCount-1; j++) {

code[j] = code[j+1];

}

codeCount--;

code = (SketchCode[]) PApplet.shorten(code);

return;

}

}

if (Base.DEBUG) {

// This can happen with the change detector, but need not be reported.

System.err.println("removeCode: could not find " + which.getFileName());

}

}

/**

public void handlePrevCode() {

int prev = currentIndex - 1;

if (prev < 0) prev = codeCount-1;

setCurrentCode(prev);

}

/**

public void handleNextCode() {

setCurrentCode((currentIndex + 1) % codeCount);

}

/**

public void setModified(boolean state) {

if (current.isModified() != state) {

current.setModified(state);

calcModified();

}

}

protected void calcModified() {

modified = false;

for (int i = 0; i < codeCount; i++) {

if (code[i].isModified()) {

modified = true;

break;

}

}

editor.repaintHeader();

if (Platform.isMacOS()) {

// http://developer.apple.com/qa/qa2001/qa1146.html

Object modifiedParam = modified ? Boolean.TRUE : Boolean.FALSE;

// https://developer.apple.com/library/mac/technotes/tn2007/tn2196.html#WINDOW_DOCUMENTMODIFIED

editor.getRootPane().putClientProperty("Window.documentModified", modifiedParam);

}

}

public boolean isModified() {

return modified;

}

/**

public void updateSketchCodes() {

current.setProgram(editor.getText());

}

/**

public boolean save() throws IOException {

// make sure the user didn't hide the sketch folder

ensureExistence();

// first get the contents of the editor text area

updateSketchCodes();

// don't do anything if not actually modified

//if (!modified) return false;

if (isReadOnly()) {

// if the files are read-only, need to first do a "save as".

Messages.showMessage(Language.text("save_file.messages.is_read_only"),

Language.text("save_file.messages.is_read_only.description"));

// if the user cancels, give up on the save()

if (!saveAs()) return false;

}

for (SketchCode sc : code) {

if (sc.isModified()) {

sc.save();

}

}

calcModified();

return true;

}

/**

public boolean saveAs() throws IOException {

String newParentDir = null;

String newSketchName = null;

final String PROMPT = Language.text("save");

// https://github.com/processing/processing4/issues/77

boolean useNative = Preferences.getBoolean("chooser.files.native");

if (useNative) {

// get new name for folder

FileDialog fd = new FileDialog(editor, PROMPT, FileDialog.SAVE);

if (isReadOnly() || isUntitled()) {

// default to the sketchbook folder

fd.setDirectory(Preferences.getSketchbookPath());

} else {

// default to the parent folder of where this was

fd.setDirectory(folder.getParent());

}

String oldFolderName = folder.getName();

fd.setFile(oldFolderName);

fd.setVisible(true);

newParentDir = fd.getDirectory();

newSketchName = fd.getFile();

} else {

JFileChooser fc = new JFileChooser();

fc.setDialogTitle(PROMPT);

if (isReadOnly() || isUntitled()) {

// default to the sketchbook folder

fc.setCurrentDirectory(new File(Preferences.getSketchbookPath()));

} else {

// default to the parent folder of where this was

fc.setCurrentDirectory(folder.getParentFile());

}

// can't do this, will try to save into itself by default

//fc.setSelectedFile(folder);

int result = fc.showSaveDialog(editor);

if (result == JFileChooser.APPROVE_OPTION) {

File selection = fc.getSelectedFile();

newParentDir = selection.getParent();

newSketchName = selection.getName();

}

}

// user canceled selection

if (newSketchName == null) return false;

boolean sync = Preferences.getBoolean("editor.sync_folder_and_filename");

String newMainFileName = null; // only set with !sync

File newFolder;

if (sync) {

// before 4.0 beta 6

//String sanitaryName = Sketch.checkName(newSketchName);

String newMainName = sanitizeName(newSketchName);

newFolder = new File(newParentDir, newMainName);

if (!newMainName.equals(newSketchName) && newFolder.exists()) {

Messages.showMessage(Language.text("save_file.messages.sketch_exists"),

Language.interpolate("save_file.messages.sketch_exists.description",

newMainName));

return false;

}

newSketchName = newMainName;

newMainFileName = newMainName + "." + mode.getDefaultExtension();

} else {

newFolder = new File(newParentDir, newSketchName); // sketch folder name can be different

}

// make sure there doesn't exist a tab with that name already

// but ignore this situation for the first tab, since it's probably being

// re-saved (with the same name) to another location/folder.

for (int i = 1; i < codeCount; i++) {

if (newSketchName.equalsIgnoreCase(code[i].getPrettyName())) {

Messages.showMessage(Language.text("save_file.messages.tab_exists"),

Language.interpolate("save_file.messages.tab_exists.description",

newSketchName));

return false;

}

}

// check if the paths are identical

if (newFolder.equals(folder)) {

// just use "save" here instead, because the user will have received a

// message (from the operating system) about "do you want to replace?"

return save();

}

// check to see if the user is trying to save this sketch inside itself

try {

// Includes the separator so that a/b/c is different from a/b/c2.

// (a/b/c matches a/b/c2, but a/b/c/ does not match a/b/c2/)

String newPath = newFolder.getCanonicalPath() + File.separator;

String oldPath = folder.getCanonicalPath() + File.separator;

if (newPath.indexOf(oldPath) == 0) {

Messages.showWarning(Language.text("save_file.messages.recursive_save"),

Language.text("save_file.messages.recursive_save.description"));

return false;

}

} catch (IOException ignored) { }

// if the new folder already exists, then first remove its contents before

// copying everything over (user will have already been warned).

if (newFolder.exists()) {

//Util.removeDir(newFolder);

try {

Platform.deleteFile(newFolder);

} catch (IOException e) {

e.printStackTrace();

}

}

// in fact, you can't do this on Windows because the file dialog

// will instead put you inside the folder, but it happens on OS X a lot.

// now make a fresh copy of the folder

if (!newFolder.mkdirs()) {

// mkdirs() returns true when the folders are created, which should

// be the case here because we removed any existing 'newFolder' above.

// If this fails, then it probably means the removeDir() failed,

// or at least left things behind, which could mean badness later.

System.err.println("Error creating path " + newFolder);

}

// grab the contents of the current tab before saving

// first get the contents of the editor text area

updateSketchCodes();

File[] copyItems = folder.listFiles(file -> {

String name = file.getName();

// just in case the OS likes to return these as if they're legit

if (name.equals(".") || name.equals("..")) {

return false;

}

// list of files/folders to be ignored during "save as"

String[] ignorable = mode.getIgnorable();

if (ignorable != null) {

for (String ignore : ignorable) {

if (name.equals(ignore)) {

return false;

}

}

}

// ignore the extensions for code, since that'll be copied below

for (String ext : mode.getExtensions()) {