Include sketchbook folder and LibrarySettings.h

[NicoHood]

Test to improve #3717

Some notes to this PR:

• It (basically) does the same (idea) as the linked PR above
• You do not need to save the file before it is used for compiling
• A Global "LibrarySetting.h" filename is used for custom Library settings
• If it does not exists in the sketch folder it will be created emty
• You can still overwrite this empty file in the IDE again
• If you create and delete the file this wont be noticed
• The try catch may be improved, I am not a java pro.

This way you can place custom settings in this file. You can also add something like
#define LIBCONFIG_EXISTS to use custom settings or #ifndef SETTING. The reason why a specific filename is used is, that it will compile fine even if the file was not created by the user.

You can also create custom settings like MylibSetting.h and include it from the library. This makes the file required to exist. If not it will throw a compile error. If the file also exists in the library, the library file will be preferred (so you should use the Librarysettings.h instead for this usecase).

Independent Issue found:

The deletion seems to be a general IDE issue. If you create a file and compile the sketch the file is copied to the build folder. If you delete the file again it wont be noticed and the sketchfolder still has this file. (The core has the same error, which is ignored).

I tried to delete the file after each compile. That worked fine till the point when LibrarySettings.h causes a compile error. The file wont be deleted then (in the build folder). If you delete it (in the IDE) its still in the build folder.

So this is a general, separate bug. Should I open a ticket for this?

May anyone build this to test it?

[matthijskooijman]

@ArduinoBot build this please

[ffissore]

@ArduinoBot build this please

[ArduinoBot]

Build successful. Please test this code using one of the following:
http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-3757-BUILD-389-linux32.tar.xz
http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-3757-BUILD-389-linux64.tar.xz
http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-3757-BUILD-389-windows.zip
http://downloads.arduino.cc/javaide/pull_requests/arduino-PR-3757-BUILD-389-macosx.zip

[ffissore]

I guess it was sleeping...

[ffissore]

I have to put this on hold as I'm rewriting Compiler from scratch. We are internally testing it. More news will follow

[NicoHood]

Okay. If you rewrite the compiler please also consider PR #3697 which is also very important.

[PaulStoffregen]

I have to put this on hold as I'm rewriting Compiler from scratch.

Yikes!

Please please please push this to a branch, or at least the nightly build for a while, before publishing in a full release.

[NicoHood]

I have another idea if you will implement this in the new compiler:
Instead of LibrarySetting.h I'd call it just Settings.h or ArduinoSettings.h. Then include it in the Arduino.h file.

• This way we can easily overwrite things like RX_BUFFER_SIZE as well.
• We could also add options to disable the USB-Core
• We could add an option to disable the SerialEvent function. You can keep it by default for compatibility, but set a few parameters to tweak the Arduino code and save some flash
• We could use this for libraries, such as PinChangeInterrupt to effectifly make use of direct port access with pre defined pins. This also works for other libraries. A known pin at runtime is way faster and also saves a lot of time.
• Global debug options could be enabled this way.
• Many more things I can imagine of and you as well.

[ffissore]

Assigning to @cmaglie. Also see arduino/arduino-builder#15 and arduino/arduino-builder#29

[facchinm]

Closing this as the discussion about the metadata (or configuration) file is going to take place in arduino-cli repo and in the mailing list