MikroElektronika Compiler's IDE Manual

COMPILER’S IDE
TO OUR VALUED CUSTOMERS
I want to express my thanks to you for being interested in our products and having
confidence in MikroElektronika.
It is our intention to provide you with the best quality products. Furthermore, we will
continue to improve our performance to better suit your needs.
Nebojsa Matic
General Manager
3
IDE Overview
MikroElektronika's compilers have a user-friendly and intuitive Integrated Development
Environment (IDE) which provides all the benefits that modern Windows environments
offer. Besides, it can be customized to better suit various needs of the user.
Code Explorer
Project Settings
Bookmarks
Code Editor
Watch Values
Project Manager
Routine List
Macros
Breakpoints
Messages
Code Explorer
Project Settings
Code Editor
Watch Values
Project Manager
Bookmarks
Messages
Breakpoints
Stopwatch
Routine List
Library Manager
Macros
Stopwatch
Library Manager
enables easy code writing;
allows general project settings;
advanced text editor;
allows register and variable values monitoring while the program is running;
allows multiple project management;
make navigation through a large code easier;
displays all messages generated during compiling and linking;
displays list of breakpoints currently set in the project;
displays number of cycles/time required for a code portion to be executed;
displays list of routines in alphabetical order;
enables simple handling of libraries used in the project;
allows a series of characters (code portions) to be recorded and
reused later in the project;
4
Customizing IDE Layout
Docking windows
As mentioned above, it is possible to customoze the space for code viewing and editing
(IDE). There are many options for arranging windows within the IDE such as: tab-dock
document windows, dock tool windows to the edge of the IDE, minimize tool windows
along the edge of the IDE, tile document windows, reset window placement to the default
layout etc.
In order to dock a window within the IDE follow the steps below:
Step 1:
Click the window you want to dock. In our example, it is the Library Manager window
which appears by selecting the Library Manager option from the View drop-down
menu. Hold the CTRL key while dragging the window in order to disable docking.
Step 2:
Drag the window from its current location. A guide
diamond will appear. The four arrows of the diamond
point towards the four edges of the IDE.
Step 3: Move the pointer over the corresponding portion of the guide diamond. An outline of the window
appears in the designated area on
the screen.
Step 4: To dock the window here, release
the mouse button.
Guide
diamond
Saving Layout
Once you have created desired window layout, you can save it by typing its name and
pressing the Save Layout icon.
To set the desired layout, it is necessary to select it from the layout drop-down list and
click the Set Layout icon.
To remove a layout from the drop-down list, it is necessary to select it and click the Delete
Layout icon.
Set Layout icon
Save Layout icon
Delete Layout icon
5
Auto Hide
The Auto Hide option enables you to minimize the whole tool window along the edges
of the IDE when it is not in use in order to see more of the code.
Step 1:
Click the window you want to minimize.
Step 2:
Click the Auto Hide icon on the title bar of the window and it will automatically
slide to its tab. While the window is auto-hidden, its name and icon are visible on
its tab.
Auto Hide icon
Auto-hidden window tab
Step 3:
To display an auto-hidden window, move your pointer over the tab. The window slides back into view and is ready for use.
Step 4:
In order for the window to exit Auto hide mode, click the Auto Hide icon
while the window is visible.
Options Window
The Options window can be accessed
by clicking Options from the Tools
drop-down menu or the Options icon
or by pressing the [F12] key.
The Options window consists of three
tabs: Editor, Tools and Output. Each of
these tabs contains options for modifying
the code editor. The code is edited in the
same way as in any standard Windows
text-editor, which includes familiar Copy,
Paste and Undo commands.
6
Editor Settings Window
To access the Editor Settings window, select the first icon within the Editor tab placed
on the left portion of the Options window. This window enables you to configure the following options: Project Files, Auto Save, Highlighter, Spelling, Advanced Editor Options
and Code Folding. To access some of the advanced Editor options, click the Open
options dialog button within the Advanced Editor Options option.
7
Code Assistant [Ctrl+Space]
If you type the first few letters of a word and then press
CTRL+SPACE, all the valid identifiers matching these letters
will be shown in a floating panel (see figure on the right).
Keep on typing to narrow the choice of the identifiers, or
select one identifier from the list using the keyboard arrows
and press Enter.
Parameter Assistant [Shift+Ctrl+Space]
The Parameter Assistant option will be automatically
invoked by using opening parenthesis “(” or by pressing
SHIFT+CTRL+SPACE. If the name of a valid function precedes the parenthesis, then the expected parameters will be displayed in a floating
panel. As you type the actual parameter, the next expected parameter becomes bold.
Code Folding
The Code Folding option allows the users to selectively
hide and display sections of the source code. In this
way it is easier to manage large codes by viewing only
those sections of the code that are relevant to the current actions.
While typing the code, the code folding symbol ( AND )
appears automatically. Use this symbol to expand/collapse
code sections.
Expand code symbol
Collapse code symbol
If you place the cursor over the tooltip box ... , the
collapsed text will be shown in the tooltip style box.
Tooltip style box
Bookmarks [Ctrl+Shift+NUMBER]
The Bookmarks option makes a search through a large code easier. To set a bookmark,
use CTRL+SHIFT+NUMBER. The bookmark in the form of the sleeted number appears on
the left side of the program line. To jump to a bookmark, use CTRL+NUMBER.
Goto Line [Ctrl+G]
Similarly, the Goto Line option also makes a search through a large code easier. Use
the CTRL+G shortcut to activate this option.
8
Editor Colors Window
Options contained in the Editor Colors window allow you to customize IDE layout, i.e.
the colors of all windows and fonts. You can choose any of the predefined colour
schemes, edit them or make new ones. Besides, options in this window enable you to
change text attributes (Bold, Italic, Underline or Strikeout).
Auto Correct Window
The Auto Correct option is used for correcting common typing mistakes. To access the
list of recognized typos, click the Auto Correct icon in the Editor tab. You can also add
your own preferences to the list.
9
Auto Complete Window
The process of program writing may be sped up by using the Auto Complete option in
a way that a keyword in the program is replaced by the code portion (can be any text)
previously assigned to that word. To add a new keyword to the list of valid keywords, click
the Add button within the Auto Complete window, enter its name, description and appropriate code to replace it in the program. To confirm it, click the Apply button. If you type
a keyword anywhere in the program and press CTRL+J, it will be automatically replaced
by the appropriate code.
Macros
A macro represents a series of characters that have been 'recorded'
so they can be reused in the code.
Auto complete macros can retrieve system information and include it in the project:
%DATE% - date of program writing;
%TIME% - current time;
%DEVICE% - device (MCU) name as specified in project settings;
%DEVICE_CLOCK% - clock as specified in project settings; and
%COMPILER% - version of compiler in use.
10
Tools
The Options window also contains the Tools tab which enables the use of shortcuts to
external programs, such as Calculator or Notepad. Up to 10 different shortcuts may be
set by defining potential shortcuts Tool0 - Tool9.
Output
By clicking the Output Settings icon within the Output tab, it is possible to configure the
number and type of output files (ASM files and List file) as well as the optimization level
of the compiled code.
11
Code Explorer Window
The Code Explorer window appears by clicking the Code
Explorer option from the View drop-down menu. It gives a
clear view of each item declared within the source code. It is
possible to jump to the declaration of any item by right clicking it. Apart from the list of defined and declared items, the
Code Explorer window displays a message about the first
error and it's location in the code.
The Full Expand/Collapse and Locate in code options are
available in the Code Explorer window.
Routine List Window
The Routine List window appears by clicking the Routine List option from the View drop-down menu. It displays all available routines in alphabetical order. This window can also be accessed by pressing CTRL+L.
Jump to a desired routine may be executed by double
clicking it.
Project Manager Window
The Project Manager option from the View drop-down
menu allows the user to manage multiple projects.
Several projects, which together make a project group,
can be simultaneously opened, but only one of them can
be active at the time.
Any project within the Project Manager window may
become active by double clicking it.
Options available in the Project Manager window:
- Save Project Group;
- Open Project Group;
- Close Project;
- Close Project Group;
- Add Project To Project Group;
- Remove Project From Project Group;
- Add File to Project;
- Remove File From Project;
- Build Project (Ctrl+F9); and
- mE Programmer (F11).
12
Project Settings Window
The Project Settings window, which appears by clicking the Project Settings option
from the View drop-down menu, contains several options. The Device option is used for
selecting the appropriate device from the device drop-down list. The Oscillator option is
used for entering the oscillator frequency value. PIC microcontrollers contain the
Build/Debugger Type option, whereas 8051 microcontrollers contain the Memory
Model option used for selecting a desired memory model.
Project settings for PIC
Project settings for 8051
Project settings for AVR
Library Manager Window
The Library Manager window, which appears by clicking
on the Library Manager option from the View drop-down
list, lists all the libraries (extension .mcl) which are currently stored in the Uses folder and enables you use them in
the project. A desired library is added to the project by putting a tick in the check box next to the library name.
In order to have all library functions accessible, it is sufficient to simply click the Check All button and all the
libraries will be selected. If none of these libraries are needed in the project, click the Clear All button and all the
libraries will be cleared from the project.
Only selected libraries will be included in the project and
linked if needed.
Library Dependencies
Certain libraries use (depend on) functions and/or variables and constants defined in
other libraries. For example, the SPI_Glcd library uses Glcd_Fonts and Port_Expander
libraries. The Port_Expander library uses the SPI library. It means that if you check the
SPI_Glcd library in the Library Manager window, all the libraries on which it depends will
also be checked.
13
Messages Window
The Messages window appears by clicking on the Messages option in the View dropdown menu. It can also be accessed by clicking the Windows option from the same
menu. The Messages window is located at the bottom of the main window by default
and displays locations and types of errors encountered by the compiler. If errors are
encountered during the process of compiling, the compiler will report them and will not
generate a hex file. The compiler also reports warnings, but these do not affect the output file. In other words, only errors can interfere with the generation of hex file.
Statistics Window
After successful compilation, you can review statistics of your code. Click the
Statistic icon
and choose appropriate statistic overview from the window for it
to appear.
Statistics tabs
Main Statistics window with the Summary tab activated
14
Here are examples of some of the statistic overviews:
RAM Memory Usage
Used RAM Locations
SFR Locations
ROM Memory Usage
Functions Sorted By Name
Functions Sorted By Name Chart
Functions Sorted By Address Chart
Functions Tree
15
Integrated Tools
USART Terminal Window
Compilers include the USART terminal for RS232 communication. As such, it represents
a good substitute for the standard Windows Hyper terminal. To show its window, select
the USART Terminal option from the Tools drop-down menu or click the USART Terminal icon from the Tools toolbar. The USART Terminal window contains options for serial communication configuration and displays sent/received data.
EEPROM Editor Window
The EEPROM Editor window appears by selecting the EEPROM Editor option from the
Tools drop-down menu. It is used for manipulating MCU's EEPROM memory. For the
purpose of modifying individual locations, it is necessary to enter a new value in the .hex
format for appropriate address. If the new value is to be of Byte, Word or DWord type,
select appropriate option at the bottom of the window, enter the value in the Edit Value
field and click the Edit button. At last, click the Save button to save data as a document
with the .hex extension. If the Use EEPROM in Project option is checked, this data will
be automatically loaded during the process of programming.
16
ASCII Chart Window
The ASCII Chart window is a handy tool used when
working with LCD display. Select the ASCII Chart
option from the Tools drop-down menu or click the
View ASCII Chart icon from the Tools toolbar. The
ASCII Chart window shows standard ASCII character
codes.
Seven Segment Editor
The Seven Segment Editor window is a convenient
visual panel which displays decimal/hex values for
any pattern the user would like to display on a 7-segment display. These values will be shown in the boxes
next to the image. A desired pattern is created by
clicking on the parts of the 7-segment image. Select
the Seven Segment Editor option from the Tools
drop-down menu or click the Seven segment editor
icon from the Tools toolbar.
HID Terminal
The mikroBasic PRO for PIC compiler includes
the HID terminal for USB communication. To
access it, select the HID Terminal option from the
Tools menu.
17
UDP Terminal
The compiler includes the UDP Terminal. To access it, select the UDP Terminal option
from the Tools menu.
Graphic LCD Bitmap Generator
The compiler includes the Graphic LCD Bitmap Generator. To access it, select the GLCD
Bitmap Editor option from the Tools drop-down menu. For it to appear In the window,
select the type of display to use and load desired picture in the bmp. format. The picture
must be monochromatic and must be in the same resolution as the display selected. The
generator output is a program compatible code.
18
LCD Custom Character Generator
The compiler includes the LCD Custom Character generator. To access it, select the LCD
Custom Character option from the Tools menu. It is used similarly to the Seven Segment Editor tool. Create a symbol by clicking the small square fields, specify its position
and row and click the GENERATE button. The generator output is a program compatible
code.
mikroBootloader
The PIC16F87X family of microcontrollers has the ability to modify its own program memory while working. This feature allows a small bootloader program to be loaded into the
microcontroller memory. Thanks to it, a new executable code (firmware) can be loaded
into the microcontroller, if needed, using serial communication. No extra programmer is
needed. The simplest bootloaders start the user code execution, unless a new firmware
needs to be downloaded. If it is necessary to download a new firmware, the bootloader
receives data and writes it into the program memory. There are many variations and additional features that can be added to improve reliability and simplify the use of the bootloader. mikroBootloader can be used only with PIC microcontrollers which are able to
modify their own Flash memory.
19
Software Simulator Overview
A software simulator is an integral part of the compiler. It is designed to simulate the operation of microcontrollers and assist the user in debugging code written for these devices.
After you have successfully compiled your project, you can run the software simulator by
selecting the Start Debugger option from the Run drop-down menu, or by clicking the
Start Debugger icon from the Debugger toolbar. Starting the software simulator makes
more options available such as Step Into, Step Over, Step Out, Run to Cursor, etc. The
next line to execute is highlighted in blue by default.
Watch Values Window
The Watch Values window is the main software simulator window which allows you to
monitor addresses and values of the microcontroller’s variables and registers while simulating the program. To access it, select the Debug Windows › Watch Window option
from the View drop-down menu.
There are two ways of adding variable/register to the watch list. One is by adding their
real names (variable name in the code). It is sufficient to select the desired variable/register in the Select variable from list field and click the Add button. The other is by
adding their assigned names (assembly variable name). Just type the assigned name of
the variable/register you want to display in the Search the variable by assembly name
field and click the Add button.
Note
The Software Simulator simulates the program flow and execution of instruction lines, but
it cannot fully emulate device behavior, i.e. it doesn’t update timers, interrupt flags, etc.
20
Variables can also be removed from the Watch Values window by selecting the desired
variable and clicking the Remove button.
The Add All button adds all variables to the list.
The Remove All button removes all variables from the list.
Values change during the process of simulation. Recently changed items are colored red.
Double click on a variable or the Properties button opens the Edit Value window in
which you can assign a new value to the selected variable/register. You can choose
between decimal, hexadecimal, binary, float or character format of the variable/register
representation. All representations except float are unsigned by default. For signed representation, check the box next to the Signed label.
A variable/register value can also be changed by double clicking on it’s field and typing
a new value directly.
Stopwatch Window
The software simulator Stopwatch window appears by selecting the Debug Windows ›
View Stopwatch option from the View drop-down menu.
The Stopwatch window displays the number of cycles or time required for a code portion to be executed. The stopwatch measures the execution time (number of cycles)
since the moment the software simulator started and can be reset at any point. The Delta
field shows the number of cycles between the lines where the software simulator action
started and ended. The user can change the clock value in the Stopwatch window,
which will cause the required time to be recalculated. Changing clock value does not
affect current project settings, but provides accurate simulation.
21
RAM Window
The software simulator RAM window appears by selecting Debug Windows › RAM Window from the View drop-down menu.
The RAM window displays a map of the microcontroller RAM memory, with recently
changed items colored red. The value of any field may be changed by double-clicking it.
Software simulator options:
Name
Start
Debugger
Run/Pause
Debugger
Stop
Debugger
Description
Function key
Start up software simulator.
[F9]
Run or pause software simulator.
[F6]
Stop software simulator.
[Ctrl+F2]
Toggle
Breakpoint
During the process of simulating, the program executes until a
breakpoint has been reached. The Toogle Breakpoints option sets
new breakpoints or removes those already set at the current cursor
position. The list of all breakpoints may be viewed by selecting the
Breakpoints option from the Run menu. To locate a breakpoint,
double click on it in the Breakpoints window.
[F5]
Run To
Cursor
Execute the program until the cursor position has been reached.
[F4]
Step Into
Step Over
Step Out
Execute the current program line, then halts. If the program line
executed calls another routine, the software simulator steps into the
routine and halts after executing the first instruction within it.
Execute the current program line, then halts. If the program line
executed calls another routine, the software simulator will not step
into it. The whole routine will be executed and the software
simulator halts at the first instruction following the call.
Execute all remaining program lines within the subroutine. The
software simulator halts immediately upon exiting the subroutine.
[F7]
[F8]
[Ctrl+F8]
22
Keyboard Shortcuts
A complete list of keyboard shortcuts available in the compiler’s IDE:
IDE Shortcuts
F1 ........................
Ctrl+N ................
Ctrl+O ................
Ctrl+Shift+O ........
Ctrl+Shift+N ........
Ctrl+K ..................
Ctrl+F4 ................
Ctrl+Shift+E ........
Ctrl+F9 ................
Shift+F9 ..............
Ctrl+F11 ..............
Shift+F4 ..............
Ctrl+Shift+F5 ......
F11 ......................
Ctrl+Shift+F11..........
F12 ......................
Alt+X ....................
Help
New Unit
Open
Open Project
New Project
Close Project
Close unit
Edit Project
Build
Build All
Build and Program
View breakpoints
Clear breakpoints
Start mE Programmer
Project Manager
Options
Close mikroC PRO
Basic Editor Shortcuts
F3 ........................
Shift+F3 ..............
Alt+F3 ................
Ctrl+A ..................
Ctrl+C ................
Ctrl+F ..................
Ctrl+R ................
Ctrl+P ..................
Ctrl+S ..................
Ctrl+Shift+S ........
Ctrl+V ..................
Ctrl+X ..................
Ctrl+Y ..................
Ctrl+Z ..................
Ctrl+Shift+Z ........
Find, Find Next
Find Previous
Find in Files
Select All
Copy
Find
Replace
Print
Save unit
Save All
Paste
Cut
Delete entire line
Undo
Redo
Advanced Editor Shortcuts
Ctrl+Space .......... Code Assistant
Ctrl+Shift+Space.. Parameters Assistant
Ctrl+D ................ Find declaration
Ctrl+E ..................
Ctrl+L ..................
Ctrl+G ................
Ctrl+J ..................
Ctrl+Shift+. ..........
Ctrl+Shift+, ..........
Ctrl+number ........
Ctrl+Shift+number
Ctrl+Shift+I ..........
Ctrl+Shift+U ........
TAB ....................
Shift+TAB ............
Alt+Select ..........
Ctrl+Alt+Select ....
Ctrl+Alt+L ............
Ctrl+Alt+U ..........
Ctrl+Alt+T ............
Ctrl+T ..................
Ctrl+Q ..................
Incremental Search
Routine List
Goto line
Insert Code Template
Comment Code
Uncomment Code
Goto bookmark
Set bookmark
Indent selection
Unindent selection
Indent selection
Unindent selection
Select columns
Select columns
Convert Selection to
lowercase
Convert Selection to
uppercase
Convert to Titlecase
USART Terminal
Quick Converter
mikroICD Debugger and
Software Simulator Shortcuts
F2 ........................
F4 ........................
F5 ........................
F6 ........................
F7 ........................
F8 ........................
F9 ........................
Ctrl+F2 ................
Ctrl+F5 ................
Ctrl+F8 ................
Alt+D ..................
Shift+F5 ..............
Ctrl+Shift+A ........
Jump To Interrupt
Run to Cursor
Toggle Breakpoint
Run/Pause Debugger
Step into
Step over
Debug
Stop Debugger
Add to Watch List
Step out
Disassembly view
Open Watch window
Show Advanced
Breakpoints
DISCLAIMER
All the products owned by MikroElektronika are protected by copyright law and
international copyright treaty. Therefore, this manual is to be treated as any other
copyright material. No part of this manual, including product and software described
herein, may be reproduced, stored in a retrieval system, translated or transmitted in any
form or by any means, without the prior written permission of MikroElektronika. The
manual PDF edition can be printed for private or local use, but not for distribution. Any
modification of this manual is prohibited.
MikroElektronika provides this manual ‘as is’ without warranty of any kind, either
expressed or implied, including, but not limited to, the implied warranties or conditions of
merchantability or fitness for a particular purpose.
MikroElektronika shall assume no responsibility or liability for any errors, omissions and
inaccuracies that may appear in this manual. In no event shall MikroElektronika, its
directors, officers, employees or distributors be liable for any indirect, specific, incidental
or consequential damages (including damages for loss of business profits and business
information, business interruption or any other pecuniary loss) arising out of the use of
this manual or product, even if MikroElektronika has been advised of the possibility of
such damages. MikroElektronika reserves the right to change information contained in
this manual at any time without prior notice, if necessary.
All the product and corporate names appearing in this manual may or may not be
registered trademarks or copyrights of their respective companies, and are only used for
identification or explanation and to the owners’ benefit, with no intent to infringe.
HIGH RISK ACTIVITIES
The products of MikroElektronika are not fault – tolerant nor designed, manufactured or
intended for use or resale as on – line control equipment in hazardous environments
requiring fail – safe performance, such as in the operation of nuclear facilities, aircraft
navigation or communication systems, air traffic control, direct life support machines or
weapons systems in which the failure of Software could lead directly to death, personal
injury or severe physical or environmental damage (‘High Risk Activities’).
MikroElektronika and its suppliers specifically disclaim any expressed or implied warranty
of fitness for High Risk Activities.
Copyright 2003 – 2009 by MikroElektronika. All rights reserved
If you want to learn more about our products, please visit our website: www.mikroe.com
If you are experiencing some problems with any of our products or just need additional information, please place
your ticket at www.mikroe.com/en/support
If you have any question, comment or business proposal, do not hesitate to contact us: [email protected]
">