Merge branch 'master' into BV_macro

Author: James Foster

.gitattributes

@@ -1,2 +1,40 @@
+# https://docs.github.com/en/github/using-git/configuring-git-to-handle-line-endings
+# https://git-scm.com/docs/gitattributes
+# https://git-scm.com/docs/git-config 
+# https://adaptivepatchwork.com/2012/03/01/mind-the-end-of-your-line/ 
+
+# Configure this repository to use Git's type detection algorithm to guess 
+# whether a file is text or binary. Text files will have line endings converted 
+# as if you had set 
+#   eol=native
+# That is, on Windows text files will have CRLF line endings in your working
+# directory while on Linux and macOS your text files will have LF line endings
+# in your working directory. In either case, they will have LF line endings in
+# the Git repository itself.
+
 # Set the default behavior, in case people don't have core.autocrlf set.
-* text eol=lf
+* text=auto
+
+# Explicitly declare text files you want to always be normalized and converted
+# to native line endings on checkout. Git would likely get these right, but
+# we can be sure by adding them here.
+*.ino   text diff=cpp
+*.c     text diff=c
+*.cc    text diff=cpp
+*.cxx   text diff=cpp
+*.cpp   text diff=cpp
+*.c++   text diff=cpp
+*.hpp   text diff=cpp
+*.h     text diff=c
+*.h++   text diff=cpp
+*.hh    text diff=cpp
+
+*.md    text
+*.yaml  text
+*.yml   text
+
+
+# Denote all files that are truly binary and should not be modified.
+# Even if we don't have any of these, they make a good example.
+*.png   binary
+*.jpg   binary

.github/workflows/README.md

@@ -7,4 +7,4 @@ In this project, we define a workflow for each target platform.  **If you're loo
 
 The reason that all platforms are tested in _this_ project is to ensure that, as a framework, `arduino_ci` will run properly on any developer's personal workstation (regardless of OS).
 
-For testing an individual Arduino library in the context of GitHub, [Linux is the cheapest option](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions) and produces results identical to the other OSes.
+For testing an individual Arduino library in the context of GitHub, [Linux is the cheapest option](https://docs.github.com/en/free-pro-team@latest/github/setting-up-and-managing-billing-and-payments-on-github/about-billing-for-github-actions) and should produce results identical to the other OSes.

.github/workflows/linux.yaml

@@ -1,7 +1,7 @@
 # This is the name of the workflow, visible on GitHub UI
 name: linux
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
   "unittest_lint_sampleproject":

.github/workflows/macos.yaml

@@ -1,7 +1,7 @@
 # This is the name of the workflow, visible on GitHub UI
 name: macos
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
   "unittest_lint_sampleproject":

.github/workflows/windows.yaml

@@ -1,7 +1,7 @@
 # This is the name of the workflow, visible on GitHub UI
 name: windows
 
-on: [pull_request]
+on: [push, pull_request]
 
 jobs:
   "unittest_lint_sampleproject":

CHANGELOG.md

@@ -7,10 +7,18 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 ### Added
+- Show output from successful compile
+- `--min-free-space=N` command-line argument to fail if free space is below requred value
 
 ### Changed
+- Fix copy/paste error to allow additional warnings for a platform
+- Properly report compile errors in GitHub Actions (#296)
+- Put build artifacts in a separate directory to reduce clutter.
 - Change 266 files from CRLF to LF.
 - Add `_BV()` macro.
+- Replace `#define yield() _NOP()` with `inline void yield() { _NOP(); }` so that other code can define a `yield()` function.
+- Update .gitattributes so we have consistent line endings
+- Run tests on push as well as on a pull request so developers can see impact
 
 ### Deprecated
 
@@ -28,6 +36,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ### Changed
 - Topmost installtion instructions now suggest `gem install arduino_ci` instead of using a `Gemfile`.  Reasons for using a `Gemfile` are listed and discussed separately further down the README.
+- Stream::readStreamUntil() no longer returns delimiter
 
 ### Removed
 - scanning of `library.properties`; this can and should now be performed by the standalone [`arduino-lint` tool](https://arduino.github.io/arduino-lint).

SampleProjects/TestSomething/.arduino-ci.yml

@@ -1,3 +1,18 @@
+platforms:
+  uno:
+    board: arduino:avr:uno
+    package: arduino:avr
+    gcc:
+      features:
+      defines:
+        - __AVR__
+        - __AVR_ATmega328P__
+        - ARDUINO_ARCH_AVR
+        - ARDUINO_AVR_UNO
+      warnings:
+        - no-unknown-attributes
+      flags:
+
 unittest:
   platforms:
     - uno

SampleProjects/TestSomething/test/stream.cpp

@@ -69,4 +69,16 @@ unittest(stream_parse)
 
 }
 
+unittest(readStringUntil) {
+  String data = "";
+  unsigned long micros = 100;
+  data = "abc:def";
+
+  Stream s;
+  s.mGodmodeDataIn = &data;
+  s.mGodmodeMicrosDelay = &micros;
+  // result should not include delimiter
+  assertEqual("abc", s.readStringUntil(':'));
+  assertEqual("def", s.readStringUntil(':'));
+}
 unittest_main()

cpp/arduino/Arduino.h

@@ -36,11 +36,11 @@ typedef uint8_t byte;
 #define highByte(w) ((uint8_t) ((w) >> 8))
 #define lowByte(w) ((uint8_t) ((w) & 0xff))
 
-// might as well use that NO-op macro for these, while unit testing
-// you need interrupts? interrupt yourself
-#define yield() _NOP()
-#define interrupts() _NOP()
-#define noInterrupts() _NOP()
+// using #define for these makes it impossible for other code to use as function
+// names!
+inline void yield() { _NOP(); }
+inline void interrupts() { _NOP(); }
+inline void noInterrupts() { _NOP(); }
 
 // TODO: correctly establish this per-board!
 #define F_CPU 1000000UL

cpp/arduino/Stream.h

@@ -186,7 +186,7 @@ class Stream : public Print
         ret = String(*mGodmodeDataIn);
         mGodmodeDataIn->clear();
       } else {
-        ret = mGodmodeDataIn->substring(0, idxTrm + 1);
+        ret = mGodmodeDataIn->substring(0, idxTrm);
         fastforward(idxTrm + 1);
       }
       return ret;