diff options
author | Marti Bolivar <mbolivar@leaflabs.com> | 2011-11-15 12:45:43 -0500 |
---|---|---|
committer | Marti Bolivar <mbolivar@leaflabs.com> | 2012-04-11 16:56:50 -0400 |
commit | f36fae273ec84ee2c53a33caa2dddea2d79db0da (patch) | |
tree | fcdaf01cc72a69ca8252213eec35fa0c4aba9ce0 /libraries | |
parent | 526d51aa2b83c7a73a2ecdba8525d2a0847e5587 (diff) | |
download | librambutan-f36fae273ec84ee2c53a33caa2dddea2d79db0da.tar.gz librambutan-f36fae273ec84ee2c53a33caa2dddea2d79db0da.zip |
Move public headers to include directories; related cleanups.
Move libmaple/*.h to (new) libmaple/include/libmaple/. The new
accepted way to include a libmaple header foo.h is with:
#include <libmaple/foo.h>
This is more polite in terms of the include namespace. It also allows
us to e.g. implement the Arduino SPI library at all (which has header
SPI.h; providing it was previously impossible on case-insensitive
filesystems due to libmaple's spi.h).
Similarly for Wirish.
The old include style (#include "header.h") is now deprecated.
libmaple/*.h:
- Change include guard #defines from _FOO_H_ to _LIBMAPLE_FOO_H_.
- Add license headers where they're missing
- Add conditional extern "C" { ... } blocks where they're missing
(they aren't always necessary, but we might was well do it against
the future, while we're at it.).
- Change includes from #include "foo.h" to #include <libmaple/foo.h>.
- Move includes after extern "C".
- Remove extra trailing newlines
Note that this doesn't include the headers under libmaple/usb/ or
libmaple/usb/usb_lib. These will get fixed later.
libmaple/*.c:
- Change includes from #include "foo.h" to #include <libmaple/foo.h>.
Makefile:
- Add I$(LIBMAPLE_PATH)/include/libmaple to GLOBAL_FLAGS. This allows
for users (including Wirish) to migrate their code, but should go
away ASAP, since it slows down compilation.
Wirish:
- Move wirish/**/*.h to (new) wirish/include/wirish/. This ignores
the USB headers, which, as usual, are getting handled after
everything else.
- Similarly generify wirish/boards/ structure. For each supported
board "foo", move wirish/boards/foo.h and wirish/boards/foo.cpp to
wirish/boards/foo/include/board/board.h and
wirish/boards/foo/board.cpp, respectively. Also remove the #ifdef
hacks around the .cpp files.
- wirish/rules.mk: put wirish/boards/foo/include in the include path
(and add wirish/boards/foo/board.cpp to the list of sources to be
compiled). This allows saying:
#include <board/board.h>
instead of the hack currently in place. We can allow the user to
override this setting later to make adding custom board definitions
easier.
- Disable -Werror in libmaple/rules.mk, as the current USB warnings
don't let the olimex_stm32_h103 board compile. We can re-enable
-Werror once we've moved the board-specific bits out of libmaple
proper.
libraries, examples:
- Update includes accordingly.
- Miscellaneous cosmetic fixups.
Signed-off-by: Marti Bolivar <mbolivar@leaflabs.com>
Diffstat (limited to 'libraries')
-rw-r--r-- | libraries/FreeRTOS/MapleFreeRTOS.h | 2 | ||||
-rw-r--r-- | libraries/LiquidCrystal/LiquidCrystal.cpp | 2 | ||||
-rw-r--r-- | libraries/LiquidCrystal/LiquidCrystal.h | 4 | ||||
-rw-r--r-- | libraries/Servo/Servo.cpp | 8 | ||||
-rw-r--r-- | libraries/Servo/Servo.h | 10 | ||||
-rw-r--r-- | libraries/Wire/Wire.cpp | 1 | ||||
-rw-r--r-- | libraries/Wire/Wire.h | 4 |
7 files changed, 13 insertions, 18 deletions
diff --git a/libraries/FreeRTOS/MapleFreeRTOS.h b/libraries/FreeRTOS/MapleFreeRTOS.h index 839e3e2..dc06979 100644 --- a/libraries/FreeRTOS/MapleFreeRTOS.h +++ b/libraries/FreeRTOS/MapleFreeRTOS.h @@ -27,7 +27,7 @@ #ifndef __MAPLE_FREERTOS_H__ #define __MAPLE_FREERTOS_H__ -#include "wirish.h" +#include <wirish/wirish.h> extern "C" { #define GCC_ARMCM3 diff --git a/libraries/LiquidCrystal/LiquidCrystal.cpp b/libraries/LiquidCrystal/LiquidCrystal.cpp index 85e19ef..5cfb1ca 100644 --- a/libraries/LiquidCrystal/LiquidCrystal.cpp +++ b/libraries/LiquidCrystal/LiquidCrystal.cpp @@ -2,7 +2,7 @@ #include <stdio.h> #include <string.h> -#include "WProgram.h" +#include <wirish/WProgram.h> // When the display powers up, it is configured as follows: // diff --git a/libraries/LiquidCrystal/LiquidCrystal.h b/libraries/LiquidCrystal/LiquidCrystal.h index 0baf543..06a159d 100644 --- a/libraries/LiquidCrystal/LiquidCrystal.h +++ b/libraries/LiquidCrystal/LiquidCrystal.h @@ -2,8 +2,8 @@ #define LiquidCrystal_h //#include <inttypes.h> -#include "wirish.h" -#include "Print.h" +#include <wirish/wirish.h> +#include <wirish/Print.h> // commands #define LCD_CLEARDISPLAY 0x01 diff --git a/libraries/Servo/Servo.cpp b/libraries/Servo/Servo.cpp index 8fbd366..ecb85e6 100644 --- a/libraries/Servo/Servo.cpp +++ b/libraries/Servo/Servo.cpp @@ -26,10 +26,10 @@ #include "Servo.h" -#include "boards.h" -#include "io.h" -#include "pwm.h" -#include "wirish_math.h" +#include <wirish/boards.h> +#include <wirish/io.h> +#include <wirish/pwm.h> +#include <wirish/wirish_math.h> // 20 millisecond period config. For a 1-based prescaler, // diff --git a/libraries/Servo/Servo.h b/libraries/Servo/Servo.h index 7753b4b..94e1e00 100644 --- a/libraries/Servo/Servo.h +++ b/libraries/Servo/Servo.h @@ -27,14 +27,10 @@ #ifndef _SERVO_H_ #define _SERVO_H_ -#include "libmaple_types.h" -#include "timer.h" +#include <libmaple/libmaple_types.h> +#include <libmaple/timer.h> -#include "wirish_types.h" - -#ifdef MAPLE_IDE -#include "wirish.h" /* hack for IDE compile */ -#endif +#include <wirish/wirish_types.h> /* * Note on Arduino compatibility: diff --git a/libraries/Wire/Wire.cpp b/libraries/Wire/Wire.cpp index 753f831..8416525 100644 --- a/libraries/Wire/Wire.cpp +++ b/libraries/Wire/Wire.cpp @@ -30,7 +30,6 @@ */ #include "Wire.h" -#include "wirish.h" /* low level conventions: * - SDA/SCL idle high (expected high) diff --git a/libraries/Wire/Wire.h b/libraries/Wire/Wire.h index d2f3608..0640c3b 100644 --- a/libraries/Wire/Wire.h +++ b/libraries/Wire/Wire.h @@ -29,11 +29,11 @@ * interface to I2C (two-wire) communication. */ -#include "wirish.h" - #ifndef _WIRE_H_ #define _WIRE_H_ +#include <wirish/wirish.h> + typedef struct { uint8 scl; uint8 sda; |