aboutsummaryrefslogtreecommitdiffstats
path: root/docs/source/lang/cpp/include.rst
blob: 74fe7af4bb12f1da2b29ae1b62aa2eb970468682 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
.. highlight:: cpp

.. _lang-include:

``#include``
============

``#include`` is used to include outside libraries in your sketch.
This gives the programmer access to a large group of standard C
libraries (groups of pre-made functions and data types), and also
libraries written especially for Maple.

Example
-------

This example (from the `Arduino LiquidCrystal Tutorial
<http://arduino.cc/en/Tutorial/LiquidCrystal>`_) includes a library
that is used to control :ref:`LCD displays
<libraries-liquid-crystal>`::

    // include the library code:
    #include <LiquidCrystal.h>

    // initialize the library with the numbers of the interface pins
    LiquidCrystal lcd(12, 11, 5, 4, 3, 2);

    void setup() {
      // set up the LCD's number of columns and rows:
      lcd.begin(16, 2);
      // Print a message to the LCD.
      lcd.print("hello, world!");
    }

    void loop() {
      // set the cursor to column 0, line 1
      // (note: line 1 is the second row, since counting begins with 0):
      lcd.setCursor(0, 1);
      // print the number of seconds since reset:
      lcd.print(millis()/1000);
    }

Note that a ``#include`` line, like :ref:`#define <lang-define>`,
has **no semicolon**.  The compiler will print strange error messages
if you add one.

C Standard Library
------------------

The standard C library that comes with Maple is called `newlib
<http://sourceware.org/newlib/>`_.  Its main sources of documentation
are its `main reference <http://sourceware.org/newlib/libc.html>`_
page and its `math functions
<http://sourceware.org/newlib/libm.html>`_ reference page.  Here's an
example that imports the math.h library in order to take the `cube
root <http://en.wikipedia.org/wiki/Cube_root>`_ of a number::

    #include <math.h>

    void setup() {
        // no setup necessary
    }

    void loop() {
        // "cbrt" stands for "cube root"
        double cubeRootOf3 = cbrt(3.0);
        // prints a number that is approximately the cube root of 3:
        SerialUSB.println(cubeRootOf3);
    }



.. include:: cc-attribution.txt