Editing BoostC Inline Functions

Inline functions are statements that look like functions but do not really call anyting or return, the code is generated right "inline" with the statements before and after the "function call".  There are a couple of different ways to do this, and a couple of different reasons to do it.

== Ways of Creating Inline Functions==

*Using a #define
*Using a #define with arguments
*Using a inline qualifier in the function definition
*Using assembler inline  -- this is not an inline function, at least as I am using the term here.

== Reasons to Use Inline Functions ==

*Smaller faster code -- sometimes, sometimes not.  ( the first time it is used, your save the code for subroutine linkage, the second time you call you have two copies of the function )
*Avoid too deep a call return stack. 
Since there is no call/return the stack usage is zip.
*Make changes to code easier.
If the code would normally have to be changed in many places, changing the definition of the "function" can allow all the changes to be made in one place.
*Make code more readable. 
If a subroutine is called only in one place, it may still make the code more readable by using an inline function to hide or "chunk" low level details.
*Remove the chance of calling a function from both the main line and the interrupt
Because there are actually two different versions of the function.

== #define -- Some Details ==

all of a #define must be contained on one line, but a function typically requires several lines.  The lines can be simulated by the required ";" the end of statement marker, but you can still run out of line length.  You can combine different lines by using the line xxxx characer "\" at the end of a line.  This lets you change:

    if ( a == 0 ) { x = 1; y = 2; }


to 

     if ( a == 0 ) { \
         x = 1; \ 
         y = 2; \
     }
    

Much more readable and you do not run out of line length.

--- all this needs to be completed and verified in boostc

== #define with Arguments -- Some Details ==


Still to be written

== Inline C -- Some Details ==

For this method you qualify the function with the keyword inline.  According to the manual you can do anything you would with any other function.  Perhaps.  

Pros:

* Looks just like any other function.
* Easy to change back and forth with a one word change.
* Can be used with arguments and returned values.

Cons:

*You can not debug ( source code ) into the function.

== Inline Assmebler Code -- Some Details ==

This type of inline code is not a function it is simply a way of including assembler in the middl of, or inline with C code.  Not explained here yet. The manual is pretty good on this topic.

== Source Code Using Inline Functions ==


== Links ==

[http://publications.gbdirect.co.uk/c_book/chapter2/textual_program_structure.html 2.3. The Textual Structure of Programs]

[http://irc.essex.ac.uk/www.iota-six.co.uk/c/j1_the_c_preprocessor.asp The C Preprocessor]

[http://www.cs.cf.ac.uk/Dave/C/node14.html The C Preprocessor]

[http://publications.gbdirect.co.uk/c_book/chapter7/how_the_preprocessor_works.html 7.2. How the preprocessor works]

[http://en.wikipedia.org/wiki/C_preprocessor C preprocessor From Wikipedia, the free encyclopedia]


[[Category:BoostC]][[Category:PIC]]