Odd compile error: "No such file or directory" cause: #include #define SOLVED

ptillisch · October 3, 2024, 9:20am

Hi @fluxia. I think this is happening due to a bug in Arduino IDE:

Compilation fails with spurious "`No such file or directory`" error if line number of `#include` directives are changed while editor is "dirty"

opened 04:49PM - 23 Jul 24 UTC

Curvedair2024

topic: code type: imperfection

### Describe the problem An Arduino IDE editor tab can be in one of two state…s: - **Saved**: the contents of the file on disk matches the content in the editor buffer - The editor will always be in this state if the "**Auto save**" feature is enabled. - **Dirty**: the contents of the file on disk differs from the content staged in the editor buffer. - This is indicated by the presence of a ⬤ at the right side of the editor tab. Regardless of the state, when a compilation is triggered, it is the code in the editor buffer that must be compiled. At the start of the sketch compilation process, Arduino CLI performs a "library discovery" procedure, where the preprocessor is run tentatively on the sketch program repeatedly. If preprocessing fails, Arduino CLI parses the text of the error message. If it is a "`No such file or directory`" error from an `#include` directive, the header filename is extracted from that directive and the searches installed libraries are searched to find the one that provides that header file. The library is added to the compiler's ["search path"](https://gcc.gnu.org/onlinedocs/cpp/Search-Path.html), then the process repeated until either the preprocessing passes, or else a library can't be discovered for an `#include` directive (see [the flowchart](#library-discovery-overview) in the "**Additional context**" section of the issue if this isn't clear). 🐛 Sketch compilation fails if the sketch code staged in the editor buffer differs from the file on disk in a way that causes one `#include` directive to be present in the staged code at the line number of a different `#include` directive in the file on disk. ### To reproduce 1. Select **File > Preferences** from the Arduino IDE menus. 1. Uncheck the box next to "**Auto save**". 1. Click the "**OK** button. 1. Select **File > New Sketch** from the Arduino IDE menus. A new sketch will open in an Arduino IDE window. 1. Change the sketch code to the following: ```cpp #include <EEPROM.h> #include <SPI.h> #include <SoftwareSerial.h> #include <Wire.h> void setup() {} void loop() {} ``` **ⓘ** The fault will occur with any sketch that contains multiple consecutive `#include` directives. 1. Select **File > Save As...** from the Arduino IDE menus. 1. Save the sketch to any convenient location. 1. Select **Tools > Board > Arduino AVR Boards > Arduino Uno** from the Arduino IDE menus. **ⓘ** The fault will occur with any board. The "Arduino Uno" was picked arbitrarily for the sake of the demonstration. 1. Select **Sketch > Verify/Compile** from the Arduino IDE menus. 🙂 The sketch compiles without errors. 1. Add a blank line at the top of the sketch. ❗ Do not save the sketch. It must be in a "dirty" state to reproduce the fault. 1. Select **Sketch > Verify/Compile** from the Arduino IDE menus. 🐛 Compilation fails spuriously: ```text C:\Users\per\Documents\Arduino\Foo\Foo.ino:2:10: fatal error: EEPROM.h: No such file or directory #include <SPI.h> ^~~~~~~ ``` **ⓘ** Note that the `#include` directive for `EEPROM.h` is at line 1 in the file on disk, while it is at line 2 in the staged code, which is the position of the `#include` directive for `SPI.h` in the file on disk. 1. Add another blank line at the top of the sketch. ❗ Do not save the sketch. It must be in a "dirty" state to reproduce the fault. 1. Select **Sketch > Verify/Compile** from the Arduino IDE menus. 🐛 Compilation fails spuriously: ```text C:\Users\per\Documents\Arduino\Foo\Foo.ino:2:10: fatal error: EEPROM.h: No such file or directory #include <SoftwareSerial.h> ^~~~~~~~~~ ``` 1. Add another blank line at the top of the sketch. ❗ Do not save the sketch. It must be in a "dirty" state to reproduce the fault. 1. Select **Sketch > Verify/Compile** from the Arduino IDE menus. 🐛 Compilation fails spuriously: ```text C:\Users\per\Documents\Arduino\Foo\Foo.ino:2:10: fatal error: EEPROM.h: No such file or directory #include <Wire.h> ^~~~~~~~ ``` 1. Add another blank line at the top of the sketch. 1. Select **Sketch > Verify/Compile** from the Arduino IDE menus. 🙂 The sketch compiles without errors. **ⓘ** Note that the `#include` directive for `EEPROM.h` is at line 1 in the file on disk, while it is at line 5 in the staged code, which is the position of the `setup` function definition in the file on disk. ### Expected behavior Library discovery always works correctly, even when a sketch is in a "dirty" state. ### Arduino IDE version aa9b10d ### Operating system Windows ### Operating system version - Windows 10 - Windows 11 ### Additional context The fault does not occur if the sketch is not in a "dirty" state when compiled, whether the non-dirty state is achieved by the IDE's auto save, or by saving manually. --- Blank lines were added in the demo for the sake of simplicity, but the fault occurs regardless of what the content of the added line is. <a name="workaround"></a> #### Workaround Select **File > Save** from the Arduino IDE menus. <a name="library-discovery-overview"></a> #### Library discovery overview In case the text description of library discovery provided in the introduction is not clear, this flowchart might make it easier to understand: ```mermaid %%{ init: { 'flowchart': { 'curve': 'monotoneY' }, 'theme': 'base', 'themeVariables': { 'clusterBkg': '#ffffff', 'edgeLabelBackground': '#ffffff', 'lineColor': '#000000', 'primaryBorderColor': '#000000', 'primaryColor': '#f0f0f0', 'primaryTextColor': '#000000' } } }%% flowchart TB subgraph main[" "] direction TB compileCommand(["<code>compile</code> command"]) selectSketchFile[/"Select unprocessed sketch file"/] done{"All processed?"} preprocess[/"C++ preprocess"/] preprocessorError{"Error?"} parseError[/"Parse error message"/] includeError{"<code>#include</code> error?"} headerAvailable{"A library provides header?"} addToSearchPath["Add library to search path"] compile[["Compilation"]] failure(["Error"]) compileCommand --> selectSketchFile selectSketchFile --> done done -- "Yes" --------> compile done -- "No" --> preprocess preprocess --> preprocessorError preprocessorError -- "Yes" --> parseError parseError --> includeError includeError -- "Yes" --> headerAvailable headerAvailable -- "Yes" --> addToSearchPath addToSearchPath --> preprocess preprocessorError -- "No" --> selectSketchFile includeError -- "No" ----> failure headerAvailable -- "No" --> compile end ``` #### Additional reports - https://forum.arduino.cc/t/ide-2-1-bug-i-m-only-adding-a-new-blank-line/1144525 - https://forum.arduino.cc/t/ide-2-2-1-possible-compiler-bug/1208608 - https://forum.arduino.cc/t/blank-lines-inserted-at-start-of-sketch-causes-library-errors/1283385 - https://forum.arduino.cc/t/library-not-found-if-called-in-different-line-in-sketch/1023831 ### Issue checklist - [X] I searched for previous reports in [the issue tracker](https://github.com/arduino/arduino-ide/issues?q=) - [X] I verified the problem still occurs when using the latest [nightly build](https://www.arduino.cc/en/software#nightly-builds) - [X] My report contains all necessary details

Please try this:

Select File > Save from the Arduino IDE menus.
Attempt to compile the sketch again.

Does the sketch now compile successfully, without the unexpected "No such file or directory" error?

Topic		Replies	Views
Inclusione condizionata di librerie ... Software	46	16161	May 7, 2021
IDE 2.2.1 Possible Compiler Bug? IDE 2.x	37	876	July 31, 2024
grown man crying - compiler errors Programming	39	4407	May 5, 2021
Link libreria... a scelta Software	38	7906	May 7, 2021
Library not found if called in different line in sketch IDE 2.x	8	566	August 9, 2024

Odd compile error: "No such file or directory" cause: #include #define SOLVED

Related topics