Skip to content
This repository has been archived by the owner on Oct 1, 2024. It is now read-only.

Commit

Permalink
Merge build and verify
Browse files Browse the repository at this point in the history
  • Loading branch information
@hlovdal @adiazulay
hlovdal authored and adiazulay committed Jan 19, 2021
1 parent 2a2db50 commit 216e1b8
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 214 deletions.
221 changes: 9 additions & 212 deletions src/arduino/arduino.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -102,12 +102,15 @@ export class ArduinoApp {
}

/**
* Upload code to selected board
* @param {BuildMode} buildMode Build mode.
* * BuildMode.Upload: Compile and upload
* * BuildMode.UploadProgrammer: Compile and upload using the user
* selectable programmer
* @param {bool} [compile=true] - Indicates whether to compile the code when using the CLI to upload
* Runs the arduino builder to build/compile and - if necessary - upload
* the current sketch.
* @param buildMode Build mode. BuildMode.Upload: Compile and upload,
* BuildMode.UploadProgrammer: Compile and upload using the user selectable
* programmer, BuildMode.Analyze: Compile, analyze the output and generate
* IntelliSense configuration from it, BuildMode.Verify: Just compile.
* @param {bool} compile - Indicates whether to compile the code when using the CLI to upload
* @param buildDir Override the build directory set by the project settings
* with the given directory.
*/
public async build(buildMode: BuildMode, compile: boolean, buildDir?: string): Promise<boolean> {
const dc = DeviceContext.getInstance();
Expand Down Expand Up @@ -314,212 +317,6 @@ export class ArduinoApp {
return success;
}

public async verify(buildMode: BuildMode, buildDir?: string): Promise<boolean> {
const compile = true;
const dc = DeviceContext.getInstance();
const args: string[] = [];
let restoreSerialMonitor: boolean = false;
let cocopa: ICoCoPaContext;

const boardDescriptor = this.getBoardBuildString();
if (!boardDescriptor) {
return false;
}
if (!this.useArduinoCli()) {
args.push("--board", boardDescriptor);
}

if (!ArduinoWorkspace.rootPath) {
vscode.window.showWarningMessage("Cannot find the sketch file.");
return false;
}

if (!dc.sketch || !util.fileExistsSync(path.join(ArduinoWorkspace.rootPath, dc.sketch))) {
await this.getMainSketch(dc);
}

const selectSerial = async () => {
const choice = await vscode.window.showInformationMessage(
"Serial port is not specified. Do you want to select a serial port for uploading?",
"Yes", "No");
if (choice === "Yes") {
vscode.commands.executeCommand("arduino.selectSerialPort");
}
}

if (buildMode === BuildMode.Upload) {
if ((!dc.configuration || !/upload_method=[^=,]*st[^,]*link/i.test(dc.configuration)) && !dc.port) {
await selectSerial();
return false;
}

if (!compile && !this.useArduinoCli()) {
arduinoChannel.error("This command is only available when using the Arduino CLI");
return;
}

if (!this.useArduinoCli()) {
args.push("--upload");
} else {
// TODO: add the --clean argument to the cli args when v 0.14 is released (this will clean up the build folder after uploading)
if (compile) {
args.push("compile", "--upload");
} else {
args.push("upload");
}
args.push("-b", boardDescriptor);
}

if (dc.port) {
args.push("--port", dc.port);
}
} else if (buildMode === BuildMode.UploadProgrammer) {
const programmer = this.getProgrammerString();
if (!programmer) {
return false;
}
if (!dc.port) {
await selectSerial();
return false;
}

if (!compile && !this.useArduinoCli()) {
arduinoChannel.error("This command is only available when using the Arduino CLI");
return;
}

if (!this.useArduinoCli()) {
args.push("--upload");
} else {
// TODO: add the --clean argument to the cli args when v 0.14 is released (this will clean up the build folder after uploading)
if (compile) {
args.push("compile", "--upload");
} else {
args.push("upload");
}
args.push("-b", boardDescriptor);
}

if (this.useArduinoCli()) {
args.push("--programmer", programmer)
} else {
args.push("--useprogrammer", "--pref", "programmer=arduino:" + programmer)
}

args.push("--port", dc.port);
} else if (buildMode === BuildMode.Analyze) {
if (!isCompilerParserEnabled()) {
return false;
}
cocopa = makeCompilerParserContext(dc);
if (!this.useArduinoCli()) {
args.push("--verify", "--verbose");
} else {
args.push("compile", "--verbose", "-b", boardDescriptor);
}
} else {
if (!this.useArduinoCli()) {
args.push("--verify");
} else {
args.push("compile", "-b", boardDescriptor);
}
}

const verbose = VscodeSettings.getInstance().logLevel === "verbose";
if (buildMode !== BuildMode.Analyze && verbose) {
args.push("--verbose");
}

await vscode.workspace.saveAll(false);

arduinoChannel.show();
arduinoChannel.start(`${buildMode} sketch '${dc.sketch}'`);

if (!await this.runPreBuildCommand(dc)) {
return false;
}

if ((buildDir || dc.output) && compile) {
const outputPath = path.resolve(ArduinoWorkspace.rootPath, buildDir || dc.output);
const dirPath = path.dirname(outputPath);
if (!util.directoryExistsSync(dirPath)) {
logger.notifyUserError("InvalidOutPutPath", new Error(constants.messages.INVALID_OUTPUT_PATH + outputPath));
return false;
}

if (this.useArduinoCli()) {
args.push("--build-path", outputPath);

} else {
args.push("--pref", `build.path=${outputPath}`);
}

arduinoChannel.info(`Please see the build logs in output path: ${outputPath}`);
} else {
const msg = "Output path is not specified. Unable to reuse previously compiled files. Build will be slower. See README.";
arduinoChannel.warning(msg);
}

// stop serial monitor when everything is prepared and good
// what makes restoring of its previous state easier
if (buildMode === BuildMode.Upload || buildMode === BuildMode.UploadProgrammer) {
restoreSerialMonitor = await SerialMonitor.getInstance().closeSerialMonitor(dc.port);
UsbDetector.getInstance().pauseListening();
}

let success = false;

// Push sketch as last argument
args.push(path.join(ArduinoWorkspace.rootPath, dc.sketch));

const cleanup = async () => {
if (cocopa) {
cocopa.conclude();
}
if (buildMode === BuildMode.Upload || buildMode === BuildMode.UploadProgrammer) {
UsbDetector.getInstance().resumeListening();
if (restoreSerialMonitor) {
await SerialMonitor.getInstance().openSerialMonitor();
}
}
}

// TODO: Get rid of spawn's channel parameter and just support
// stdout and stderr callbacks
const stdoutCallback = (line: string) => {
if (cocopa) {
cocopa.callback(line);
if (verbose) {
arduinoChannel.channel.append(line);
}
} else {
arduinoChannel.channel.append(line);
}
}

await util.spawn(
this._settings.commandPath,
arduinoChannel.channel,
args,
undefined,
stdoutCallback,
).then(async () => {
await cleanup();
arduinoChannel.end(`${buildMode} sketch '${dc.sketch}'${os.EOL}`);
success = true;
}, async (reason) => {
await cleanup();
const msg = reason.code ?
`Exit with code=${reason.code}` :
reason.message ?
reason.message :
JSON.stringify(reason);
arduinoChannel.error(`${buildMode} sketch '${dc.sketch}': ${msg}${os.EOL}`);
});

return success;
}

public tryToUpdateIncludePaths() {
const configFilePath = path.join(ArduinoWorkspace.rootPath, constants.CPP_CONFIG_FILE);
if (!fs.existsSync(configFilePath)) {
Expand Down
2 changes: 1 addition & 1 deletion src/debug/configurationProvider.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -136,7 +136,7 @@ export class ArduinoDebugConfigurationProvider implements vscode.DebugConfigurat
config.program = path.join(ArduinoWorkspace.rootPath, outputFolder, `${path.basename(dc.sketch)}.elf`);

// always compile elf to make sure debug the right elf
if (!await ArduinoContext.arduinoApp.verify(BuildMode.Verify, outputFolder)) {
if (!await ArduinoContext.arduinoApp.build(BuildMode.Verify, true, outputFolder)) {
vscode.window.showErrorMessage("Failure to verify the program, please check output for details.");
return false;
}
Expand Down
2 changes: 1 addition & 1 deletion src/extension.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -124,7 +124,7 @@ export async function activate(context: vscode.ExtensionContext) {
location: vscode.ProgressLocation.Window,
title: "Arduino: Verifying...",
}, async () => {
await arduinoContextModule.default.arduinoApp.verify(BuildMode.Verify);
await arduinoContextModule.default.arduinoApp.build(BuildMode.Verify, true);
});
} catch (ex) {
}
Expand Down

0 comments on commit 216e1b8

Please sign in to comment.