mirror of https://github.com/tLDP/LDP
4378 lines
158 KiB
Plaintext
4378 lines
158 KiB
Plaintext
<!doctype linuxdoc system>
|
|
<!--
|
|
|
|
************************** begin comment *****************************
|
|
The following is the HOW-TO for programming in C++.
|
|
This document is in the SGML format. You must use sgml package to
|
|
process this document
|
|
************************* end of comment *****************************
|
|
|
|
-->
|
|
<!--
|
|
************************** SGML USER GUIDE *****************************
|
|
The SGML user guide on Linux is located at /usr/doc/sgml-tools
|
|
Read the example.sgml and guide.html documents.
|
|
Usage:
|
|
HTML sgml2html foo (Do not give extension .sgml here!!)
|
|
Text sgml2txt foo.sgml
|
|
Latex sgml2latex foo.sgml
|
|
|
|
(note: put extra dash - before language below, removed to compile)
|
|
Postscript sgml2latex -language=english -o ps foo.sgml
|
|
DVI sgml2latex -d foo.sgml
|
|
Lyx sgml2lyx foo.sgml
|
|
Richtext sgml2rtf foo.sgml
|
|
gnuinfo sgml2info foo.sgml
|
|
man sgml2txt -man foo.sgml
|
|
SGML sgmlcheck foo.sgml
|
|
************************* end of comment *****************************
|
|
-->
|
|
|
|
<article>
|
|
|
|
<!-- Title information -->
|
|
|
|
<title>C++ Programming HOW-TO
|
|
<!-- chapt change
|
|
C++ Programming HOW-TO
|
|
|
|
|
|
|
|
-->
|
|
<author>Al Dev (Alavoor Vasudevan)
|
|
<htmlurl url="mailto:alavoor[AT]yahoo.com"
|
|
name="alavoor[AT]yahoo.com">
|
|
<date>v41.2, 01 Feb 2002
|
|
<abstract>
|
|
This document provides a comprehensive list of C++ URL
|
|
pointers, links to C++ online textbooks, and programming tips on C++.
|
|
This document also provides a C++ library which imitates Java-language,
|
|
and which has various methods to avoid memory problems in C++. Using
|
|
this library you can compile Java's source code under C++.
|
|
This document serves as a "Home of C++ language".
|
|
The information given here will help you to program properly in C++ language
|
|
and applies to all the operating systems
|
|
that is - Linux, MS DOS, BeOS, Apple Macintosh OS, Microsoft Windows 95/98/NT/2000,
|
|
OS/2, IBM OSes (MVS, AS/400 etc..), VAX VMS, Novell Netware, all flavors of
|
|
Unix like Solaris, HPUX, AIX, SCO, Sinix, BSD, etc.. and to
|
|
all other operating systems which supplies C++ compilers (it
|
|
means almost all the operating systems on this planet).
|
|
|
|
</abstract>
|
|
|
|
<!-- Table of contents -->
|
|
<toc>
|
|
|
|
<!-- Begin the document -->
|
|
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt>Introduction
|
|
-->
|
|
<sect>Introduction
|
|
<p>
|
|
The purpose of this document is to provide you with a comprehensive list of
|
|
URL pointers and programming tips on C++. Also, this document provides a
|
|
Java-like String class, string tokenizer, memory functions and many other
|
|
functions, which can be used in general C++ applications. Various examples
|
|
are given which demonstrate the usage of this library and the Standard C++
|
|
Library.
|
|
|
|
This document is not a textbook on C++, and there are already several
|
|
excellent on-line text books on the internet. If you are new to C++ and you
|
|
never programmed in C++, then it is strongly suggested that you first either
|
|
read an online C++ textbook given in chapter <ref id="onlinebooks" name="C++
|
|
Online Textbooks"> or you buy a C++ book from online bookstores such as <url
|
|
name="Amazon" url="http://www.amazon.com"> or <url name="barnes"
|
|
url="http://www.barnesnoble.com">.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
-->
|
|
<sect1> C++ vs. Java
|
|
<p>
|
|
C++ is one of the most powerful languages and will be used for a long time in
|
|
the future in spite of emergence of Java. C++ runs <bf>extremely fast</bf>
|
|
and is in fact <bf> 10 to 20 times FASTER than </bf> Java. Java byte-code
|
|
is slower when running in a VM than the equivalent natively compiled code.
|
|
Java runs faster with JIT (Just-In-Time) compiler, but it is still slower
|
|
than C++. And optimized C++ program is about <bf>3 to 4 times faster</bf>
|
|
than Java (with JIT compiler). Then, why do people use Java? Because it is
|
|
pure object oriented and is easier to program in Java, as Java automates
|
|
memory management, and programmers do not directly deal with memory
|
|
allocations. This document attempts to automate the memory management in C++
|
|
to make it much more easy to use. The library given here will make C++ look
|
|
like Java and will enable C++ to compete with the Java language.
|
|
|
|
Because of manual memory allocations, debugging the C++ programs consumes a
|
|
major portion of time. This document will give you some better ideas and
|
|
tips to reduce the debugging time.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
-->
|
|
<sect1>Which one Ada95, C, C++, Java or PHP?
|
|
<p>
|
|
Language choice is very difficult. There are too many parameters - people,
|
|
people skills, cost, tools, politics (even national politics) and influence
|
|
of businessmen/commercial companies. The best language based on technical
|
|
merits does not get selected simply due to political decisions!
|
|
|
|
See the language comparison chart of David Wheeler at
|
|
<url name="Ada comparison chart" url="http://www.adahome.com/History/Steelman/steeltab.htm">.
|
|
Ada got 93%, Java 72%, C++ 68% and C got 53%. C++ and Java
|
|
are closer in points (only 4% difference), hence Java <bf>is not</bf> a very big revolution
|
|
as compared to C++.
|
|
Development costs of Ada is half of C++ as per
|
|
<url name="Stephen F. Zeigler" url="http://sw-eng.falls-church.va.us/AdaIC/docs/reports/cada/cada_art.html">.
|
|
Ada95 is available at -
|
|
<itemize>
|
|
<item> Ada home <url url="http://www.gnuada.org">.
|
|
<item> Google <url name="Ada index" url="http://directory.google.com/Top/Computers/Programming/Languages/Ada">
|
|
</itemize>
|
|
|
|
The C++ compiler is lot more complex than a C compiler and C++ programs may
|
|
run bit slower than C programs. But speed difference between C and C++ is
|
|
very minute - it could be few milli-seconds which may have little impact for
|
|
real-time programming. Since computer hardware, like RAM is becoming
|
|
cheaper and faster, it is worth doing code in C++ rather than C as time
|
|
saved in clarity and re-usability of C++ code offsets the slow speed.
|
|
Actually, most C++ solutions are faster and more efficient than in C, but
|
|
the problem lies mostly with the compilers, which isn't as mature as C
|
|
compilers yet.
|
|
|
|
On some system, you can use compiler options, to optimize the code
|
|
generated.
|
|
|
|
Nowadays, C is primarily used for low level systems programming to develop
|
|
operating systems, device drivers and applications which must perform fast.
|
|
|
|
<bf>Note: <it>Using the String, StringBuffer, StringTokenizer and
|
|
StringReader classes given in this howto, you can code in C++ which
|
|
"exactly" looks like Java. Parts of this document tries to close the gap
|
|
between C++ and Java, by imitating Java classes in C++.</it></bf>
|
|
|
|
If you want to bypass the edit-compile-debug-compile cycle of C++ then see
|
|
scripting languages like PHP which can be used for web development and for
|
|
general purpose programming. Scripting languages like PHP, PERL enable
|
|
rapid application development. PHP has some features of object-oriented
|
|
programming. PHP is at <url
|
|
url="http://www.linuxdoc.org/HOWTO/PHP-HOWTO.html">.
|
|
|
|
Java is a platform independent language more suitable for developing GUI
|
|
running inside web-browsers (Java applets) but it runs very slow. You
|
|
should prefer to use web-server-side programming with PHP, HTML, DHTML, XML
|
|
to get better performance. Hence, the golden rule is <it>"Web-server side
|
|
programming use PHP and web-client side (browser) programming use Java
|
|
applets"</it>. The reason is - the server-side OS (Linux) is under your
|
|
control and never changes, but you will never know what the client side
|
|
web-browser OS is. It can be Internet appliance device (embedded
|
|
Linux+Netscape) or computers running Windows 95/98/NT/2000 or Linux, Apple
|
|
Mac, OS/2, Netware, Solaris etc..
|
|
|
|
The advantage of Java is that you can create "Applets (GUI)" which can run
|
|
on any client OS platform. But the price you pay for cross-platform
|
|
portability is the performance, applications written in Java run very slow.
|
|
|
|
Hence, Java runs on "client" and PHP/C++ runs on servers when talking about
|
|
webrelated things.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
-->
|
|
<sect1>Problems facing the current C++ compilers
|
|
<p>
|
|
Since C++ is super-set of C, it has all the "bad" features of C.
|
|
Manual allocation and deallocation of memory is tedious and error prone
|
|
(see <ref id="garbage" name="Garbage Collector for C++">).
|
|
|
|
In C programming - memory leaks, memory overflows are very common due
|
|
to usage of features like -
|
|
<code>
|
|
Datatype char * and char[]
|
|
String functions like strcpy, strcat, strncpy, strncat, etc..
|
|
Memory functions like malloc, realloc, strdup, etc..
|
|
</code>
|
|
|
|
The usage of <bf>char *</bf> and <bf>strcpy</bf> causes <it>horrible</it> memory
|
|
problems due to <it>"overflow"</it>,
|
|
<it>"fence past errors"</it>, <it>"memory corruption"</it>, <it>"step-on-others-toe"</it>
|
|
(hurting other variable's memory locations) or <it>"memory leaks"</it>.
|
|
The memory problems are extremely hard to debug and are
|
|
very time consuming to fix and trouble-shoot. Memory problems bring down
|
|
the productivity of programmers. This document helps in increasing the
|
|
productivity of programmers via different methods addressed to solve the
|
|
memory defects in C++.
|
|
Memory related bugs are very tough to crack, and even experienced programmers
|
|
take several days or weeks to debug memory related problems. Memory
|
|
bugs may be hide inside the code for several months and can cause unexpected
|
|
program crashes. The memory bugs due to usage of
|
|
<bf>char *</bf> and <bf>pointers</bf> in C/C++
|
|
is costing $2 billion
|
|
every year in time lost due to debugging and downtime of programs. If you use
|
|
<bf>char *</bf> and <bf>pointers</bf>
|
|
in C++ then it is a very costly affair, especially if your program size is greater
|
|
than 10,000 lines of code.
|
|
|
|
Hence, the following techniques are proposed to overcome the faults of C.
|
|
Give preference in the following order -
|
|
<enum>
|
|
<item> Use references instead of pointers.
|
|
<item> Java style String class (given in this HOWTO) or the string class from the Standard C++ Library.
|
|
<item> Character pointers (char *) in C++ <bf>limit the usage</bf> of char * to cases where you
|
|
cannot use the String class.
|
|
<item> Character pointers (char *) in C using extern linkage specification, if you
|
|
do not want to use (char *) in C++.
|
|
</enum>
|
|
|
|
To use "C char *", you would put
|
|
all your C programs in a separate file and link to C++ programs using
|
|
the <it>linkage-specification</it> statement <bf>extern "C" </bf> -
|
|
<code>
|
|
extern "C" {
|
|
#include <some_c_header.h>
|
|
}
|
|
|
|
extern "C" {
|
|
comp();
|
|
some_c_function();
|
|
}
|
|
</code>
|
|
|
|
The <bf>extern "C"</bf> is a linkage specification and is a flag that
|
|
everything within the enclosing block (brace-surrounded) uses C linkage,
|
|
not C++ linkage.
|
|
|
|
The <bf>'String class'</bf> utilizes the constructor and destructor features
|
|
to automate memory management and provides access to functions like
|
|
<it>ltrim</it>, <it>substring</it>, etc..
|
|
|
|
See also related <ref id="standard-string" name="string class"> in your C++
|
|
compiler. The <bf>string class</bf> is part of the Standard C++ Library
|
|
library and provides many string manipulation functions.
|
|
|
|
Because the C++ <bf>'string class'</bf> and <bf>'String class'</bf> library
|
|
provides many string manipulation functions, there is less need to use the
|
|
character pointer approach to write your own string functions. Also, C++
|
|
programmers must be encouraged to use 'new', 'delete' operators instead of
|
|
using 'malloc' or 'free'.
|
|
|
|
Both string classes does everything that <bf>char *</bf> or <bf>char []</bf>
|
|
does. One of the added benefits is that you do not have to worry about the
|
|
memory problems and memory allocation at all.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
-->
|
|
<sect1> COOP - C++ Object Oriented Programming-language
|
|
<p>
|
|
A problem with C++ is that it is a superset of C, and, although programmers
|
|
can use the good (object oriented) features of C++ and avoid the bad
|
|
features of C, there is nothing to force them to do so. So, many C++ programs
|
|
are written with no object oriented features and continue to use the bad
|
|
features of C that the use of C++ should have overcome.
|
|
|
|
Therefore, I propose that we create a new version of C++ that does not
|
|
allow the use of the bad features of C.
|
|
|
|
I propose that this new version of C++ be called <bf>COOP</bf> (say koop), which
|
|
is an acronym for
|
|
<bf>C++</bf>
|
|
<bf> O</bf>bject
|
|
<bf> O</bf>riented
|
|
<bf> P</bf>rogramming-language"
|
|
. COOP should be pronounced like chicken coop. (The logo of COOP language is
|
|
a big fat Hen inside coop!)
|
|
I propose that the file extension for COOP files be .coo, which will
|
|
not conflict with .c for C programs or .cpp for C++ programs.
|
|
|
|
To begin with, write the COOP as a front end to C++. That is COOP
|
|
pre-processes the code syntax and then uses the standard C++ compiler
|
|
to compile the program.
|
|
COOP acts as a front end to C++ compiler. (To start with, COOP will be a
|
|
very good project/thesis topic for university students)
|
|
|
|
The following are some other proposed features of COOP:
|
|
<itemize>
|
|
<item> COOP will borrow some best ideas from Microsoft C#, Microsoft put lot of efforts,
|
|
and you can simply utilize them. Specs are at
|
|
<url name="csharp-specs" url="http://msdn.microsoft.com/vstudio/nextgen/technology/csharpdownload.asp">
|
|
and see <url name="C# overview" url="http://msdn.microsoft.com/vstudio/nextgen/technology/csharpintro.asp">.
|
|
<item> Is a subset of C++ language but will force programmer to
|
|
use object oriented programming.
|
|
<item> Pure Object-oriented langauge but retains syntax of C++.
|
|
<item> Remove all bad or confusing features of C++ in COOP, for e.g. multiple-inheritance,
|
|
operator overloading, limit usage of pointers, etc...
|
|
<item> Prevent writing C like programming in COOP, something which C++ currently allows.
|
|
Delete all C features which are considered bad or redundant/duplicates,
|
|
like printf, fprintf, malloc, struct, free etc..
|
|
<item> No downward compatibility to C language.
|
|
<item> Code written in COOP will be easy to maintain and is easily understandable/readable.
|
|
<item> Code written in "COOP" will be re-usable (thru components, modules, objects).
|
|
Supports re-usable software components, thereby
|
|
facilitating Rapid Application Development.
|
|
<item> COOP is simple, robust, OOP, has bare minimum syntax (avoiding
|
|
confusing, redundant, extra constructs of C++ for e.g remove struct and use class)
|
|
</itemize>
|
|
|
|
Also borrow ideas from -
|
|
<itemize>
|
|
<item> Java - Sun Microsystems put lot of effort, and you can simply utilize that.
|
|
<item> Connective C++ at <url url="http://www.quintessent.com/products/cc++">.
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> Recommended C++ Compilers <label id = "c++-compilers">
|
|
-->
|
|
<sect> Recommended C++ Compilers <label id = "c++-compilers">
|
|
<p>
|
|
The current C++ standard adopted by ISO and ANSI was first finalized in
|
|
1997, this means that not all compilers are up to pace yet, and not
|
|
supporting all features - it is extremely important that you get a standard
|
|
compliant C++ compiler.
|
|
|
|
<sect1> Compilers for MS Windows 2000/NT/95/98/ME/XP
|
|
<p>
|
|
Since MS Windows is quite popular for C++ development, the String class
|
|
library given in this document works well and runs very well on all the
|
|
versions of MS Windows i.e. MS Win XP/2000/NT/95/98/ME.
|
|
The C++ compilers for MS Windows are:
|
|
<itemize>
|
|
<item> GNU BloodShed at <url url="http://www.bloodshed.net/devcpp.html">
|
|
<item> Borland C++ compiler <url url="http://www.borland.com/bcppbuilder/freecompiler">
|
|
<item> Microsoft Visual C++ compiler <url url="http://msdn.microsoft.com/visualc">
|
|
<item> MSDOS C++ compiler <url url="http://www.delorie.com/djgpp">
|
|
</itemize>
|
|
The String class in this document is tested with all the above compilers.
|
|
It works fine with MS Visual C++ compiler v6.0, Borland C++ v5.2, Borland
|
|
C++ compiler v5.5.1 and Bloodshed compiler.
|
|
|
|
<sect1> Compilers for UNIX systems and clones
|
|
<p>
|
|
In a GNU world, you will always be best off with GCC (GNU Compiler
|
|
Collection), GCC is distributed with most Linux distributions, FreeBSD and
|
|
most other UNIX clones. The GCC homepage is located at <url
|
|
url="http://gcc.gnu.org">. The latest version of GCC (3.0) is one of the
|
|
most standards compliant compilers out there.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> String Class Varieties <label id = "String Variety">
|
|
-->
|
|
<sect> String Class Varieties <label id = "String Variety">
|
|
<p>
|
|
The string class is the one of the most vital objects in programming, and
|
|
string manipulations are most extensively used and they comprise of 20 to
|
|
60% of total code in most applications. There is a lot of varieties of
|
|
string classes. Of course, you can build your own string class by simply
|
|
inheriting from these string classes -
|
|
<itemize>
|
|
<item> String class given in this document
|
|
<ref id="Appendix A" name="Appendix A String.h">
|
|
<p>
|
|
<item> Standard C++ Library string class (ANSI/ISO string class at <url url="http://www.msoe.edu/eecs/cese/resources/stl/string.htm"> and <url url="http://www.sgi.com/tech/stl/basic_string.html">
|
|
<p>
|
|
<item> The external library Qt, has a Qt String class at <url url="http://doc.trolltech.com/qstring.html"> mirror at <url url="http://www.cs.berkeley.edu/~dmartin/qt/qstring.html">
|
|
<p>
|
|
<item> If none of these are suitable, you can build
|
|
your own string class. You can start with one or more of the
|
|
pre-built classes listed above (by using single or multiple inheritance.)
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
-->
|
|
<sect1> Multiple Inheritance - Sample Custom String class
|
|
<p>
|
|
As mentioned above, you can build your own custom string class from the
|
|
pre-built classes by single or multiple inheritance. In this section we
|
|
will build a sample custom string class by using multiple inheritance,
|
|
inheriting the standard C++ library string class and the String class
|
|
presented in Appendix A.
|
|
|
|
Start by downloading the sample file 'string_multi.h' from <ref id="Appendix A">.
|
|
|
|
That file is reproduced below:
|
|
|
|
<code>
|
|
// ******************************************************************
|
|
// Sample program to demonstrate constructing your own string class
|
|
// by deriving from the String class and stdlib's "string" class
|
|
// ******************************************************************
|
|
|
|
#ifndef __STRING_MULTI_H_ALDEV_
|
|
#define __STRING_MULTI_H_ALDEV_
|
|
|
|
#include <string>
|
|
#include "String.h"
|
|
#include "StringBuffer.h"
|
|
|
|
#ifdef NOT_MSWINDOWS
|
|
#else
|
|
using namespace std; // required for MS Visual C++ compiler Version 6.0
|
|
#endif
|
|
|
|
// Important Notes: In C++ the constructors, destructors and copy
|
|
// operator are NOT inherited by the derived classes!!
|
|
// Hence, if the operators like =, + etc.. are defined in
|
|
// base class and those operators use the base class's contructors
|
|
// then you MUST define equivalent constructors in the derived
|
|
// class. See the sample given below where constructors mystring(),
|
|
// mystring(char[]) are defined.
|
|
//
|
|
// Also when you use operator as in atmpstr + mstr, what you are really
|
|
// calling is atmpstr.operator+(mstr). The atmpstr is declared a mystring
|
|
|
|
class mystring:public String, string
|
|
{
|
|
public:
|
|
mystring():String() {} // These are needed for operator=, +
|
|
mystring(char bb[]):String(bb) {} // These are needed for operator=, +
|
|
mystring(char bb[], int start, int slength):String(bb, start, slength) {}
|
|
mystring(int bb):String(bb) {} // needed by operator+
|
|
mystring(unsigned long bb):String(bb) {} // needed by operator+
|
|
mystring(long bb):String(bb) {} // needed by operator+
|
|
mystring(float bb):String(bb) {} // needed by operator+
|
|
mystring(double bb):String(bb) {} // needed by operator+
|
|
mystring(const String & rhs):String(rhs) {} // Copy Constructor needed by operator+
|
|
mystring(StringBuffer sb):String(sb) {} // Java compatibility
|
|
mystring(int bb, bool dummy):String(bb, dummy) {} // for StringBuffer class
|
|
|
|
int mystraa; // customizations of mystring
|
|
private:
|
|
int mystrbb; // customizations of mystring
|
|
};
|
|
|
|
#endif // __STRING_MULTI_H_ALDEV_
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> Download String <label id = "Download String">
|
|
-->
|
|
<sect> Download String <label id = "Download String">
|
|
<p>
|
|
All the programs, examples are given in Appendix of this document.
|
|
You can download as a single tar zip, the String class, libraries
|
|
and example programs from
|
|
<itemize>
|
|
|
|
<item>
|
|
Go to <url url="http://www.aldev.8m.com"> and click on
|
|
"Source code C++
|
|
Programming howto" (<url name="aldev-site" url="http://www.aldev.8m.com/cppsrc.html">)
|
|
|
|
<item> Mirror sites are at -
|
|
<url name="angelfire" url="http://www.angelfire.com/country/aldev0">,
|
|
<url name="geocities" url="http://www.geocities.com/alavoor/index.html">,
|
|
<url name="virtualave" url="http://aldev0.virtualave.net">,
|
|
<url name="50megs" url="http://aldev0.50megs.com">,
|
|
<url name="theglobe" url="http://members.theglobe.com/aldev1/index.html">,
|
|
<url name="NBCi" url="http://members.nbci.com/alavoor">,
|
|
<url name="Terrashare" url="http://aldev.terrashare.com">,
|
|
<url name="Fortunecity" url="http://members.fortunecity.com/aldev">,
|
|
<url name="Freewebsites" url="http://aldev.freewebsites.com">,
|
|
<url name="Tripod" url="http://members.tripod.lycos.com/aldev">,
|
|
<url name="Spree" url="http://members.spree.com/technology/aldev">,
|
|
<url name="Escalix" url="http://www.escalix.com/freepage/aldev">,
|
|
<url name="Httpcity" url="http://www.httpcity.com/aldev/index.html">,
|
|
<url name="Freeservers" url="http://aldev.freeservers.com">.
|
|
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> How Can I trust Al Dev's String Class? <label id = "trust">
|
|
-->
|
|
<sect1> How Can I trust Al Dev's String Class? <label id = "trust">
|
|
<p>
|
|
You may a have question of mis-trust on the String class software.
|
|
To build confidence, there is a scientific method to verify the
|
|
functionality of Al Dev's String class. In modern days, computer scientists
|
|
use the CPU power instead of human brain power to verify and validate the
|
|
software. Human brain is too slow and hence it is better to use the
|
|
computer's power to test and validate software.
|
|
|
|
The program
|
|
<url name="example_String.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
(and also given in
|
|
<ref id ="Appendix A" name="Appendix A">
|
|
) has regression test module which you can use to run the regression tests
|
|
several millions of times automatically. After running the regression tests
|
|
on the String class
|
|
you can certify that the String class program is a <bf>ROCK SOLID</bf> and
|
|
a <bf>BULLET-PROOF</bf> program.
|
|
|
|
I tested the String class with
|
|
<bf>repeat cycle = 50000</bf>
|
|
and it ran and completed the program without crash. While it is running I did
|
|
not notice any memory leak. On Linux, I used /usr/bin/gtop, UNIX top command,
|
|
KDEStart->System->KDE System Guard
|
|
and KDEStart->System->Process management to monitor the cpu and memory usage.
|
|
|
|
I recommend that you start the regression test with
|
|
<bf>repeat cycle </bf> equal to 10 million or greater. The greater the
|
|
repeat cycle number the greater will be your confidence!!
|
|
Start the test and go to lunch (or go drink gharam chai - "chai peeke auvo") and come
|
|
back to see the results!!
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> Usage of String class
|
|
-->
|
|
<sect> Usage of String class
|
|
<p>
|
|
Take notice, this String class is not the same as the string class
|
|
implemented in the Standard C++ Library. This special String class is a
|
|
"home-made" String class, made to help Java programmers convert to C++. When
|
|
you are more comfortable with C++, you should use the real string class
|
|
provided in The Standard C++ Library.
|
|
|
|
To use String class, you should first refer to a sample program
|
|
"example_String.cpp" given in <ref id ="Appendix A" name="Appendix A"> and
|
|
the String class which is given in <ref id ="Appendix A" name="Appendix A">.
|
|
|
|
The <bf>'String class'</bf> is a complete replacement for char and char *
|
|
datatype. You can use <bf>'String class'</bf> just like char and get much
|
|
more functionalities. You should link with the library 'libString.a' which
|
|
you can build from the makefile given in <ref id ="Appendix A"
|
|
name="Appendix A"> and copy the library to /usr/lib or /lib directory where
|
|
all the C++ libraries are located. To use the 'libString.a' compile your
|
|
programs like -
|
|
<code>
|
|
g++ example.cpp -lString
|
|
</code>
|
|
See illustration sample code as given below -
|
|
<code>
|
|
String aa;
|
|
|
|
aa = "Creating an Universe is very easy, similar to creating a baby human.";
|
|
|
|
// You can use aa.val() like a 'char *' variable in programs
|
|
for (unsigned long tmpii = 0; tmpii < aa.length(); tmpii++)
|
|
{
|
|
//fprintf(stdout, "aa.val()[%ld]=%c ", tmpii, aa.val()[tmpii]);
|
|
fprintf(stdout, "aa[%ld]=%c ", tmpii, aa[tmpii]);
|
|
}
|
|
|
|
// Using pointers on 'char *' val ...
|
|
for (char *tmpcc = aa.val(); *tmpcc != 0; tmpcc++)
|
|
{
|
|
fprintf(stdout, "aa.val()=%c ", *tmpcc);
|
|
}
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
-->
|
|
<sect1> Operators
|
|
<p>
|
|
The
|
|
<bf>'String class'</bf>
|
|
provides these operators :-
|
|
<itemize>
|
|
<item> Equal to <bf>==</bf>
|
|
<item> Not equal to <bf>!=</bf>
|
|
<item> Assignment <bf>=</bf>
|
|
<item> Add to itself and Assignment <bf>+=</bf>
|
|
<item> String concatenation or addition <bf>+</bf>
|
|
</itemize>
|
|
For example to use operators -
|
|
<code>
|
|
String aa;
|
|
String bb("Bill Clinton");
|
|
|
|
aa = "put some value string"; // assignment operator
|
|
aa += "add some more"; // Add to itself and assign operator
|
|
aa = "My name is" + " Alavoor Vasudevan "; // string cat operator
|
|
|
|
if (bb == "Bill Clinton") // boolean equal to operator
|
|
cout << "bb is equal to 'Bill Clinton' " << endl;
|
|
|
|
if (bb != "Al Gore") // boolean 'not equal' to operator
|
|
cout << "bb is not equal to 'Al Gore'" << endl;
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
-->
|
|
<sect1> Functions
|
|
<p>
|
|
The functions provided by String class has the <bf>same name</bf>
|
|
as that of Java language's
|
|
String class. The function names and the behaviour is <bf>exactly</bf> same
|
|
as that of Java's String class. StringBuffer class is also provided.
|
|
This will facilitate portability of code
|
|
between Java and C++ (you can cut and paste and do minimum changes to code).
|
|
The code from Java's function body can be copied into C++ member function
|
|
body and with very mininum changes the code will compile under C++.
|
|
Another advantage is that developers coding in
|
|
both Java and C++ do not need to remember two
|
|
different syntax or function names.
|
|
|
|
For example to convert integer to string do -
|
|
<code>
|
|
String aa;
|
|
|
|
aa = 34; // The '=' operator will convert int to string
|
|
cout << "The value of aa is : " << aa.val() << endl;
|
|
|
|
aa = 234.878; // The '=' operator will convert float to string
|
|
cout << "The value of aa is : " << aa.val() << endl;
|
|
|
|
aa = 34 + 234.878;
|
|
cout << "The value of aa is : " << aa.val() << endl;
|
|
// The output aa will be '268.878'
|
|
|
|
// You must cast String to convert
|
|
aa = (String) 34 + " Can create infinite number of universes!! " + 234.878;
|
|
cout << "The value of aa is : " << aa.val() << endl;
|
|
// The output aa will be '34 Can create infinite number of universes!! 234.878'
|
|
</code>
|
|
|
|
Refer to
|
|
<ref id="Appendix A" name="Appendix A String.h">
|
|
for details about the String class function names. The same file String.h is
|
|
reproduced here in next section.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Renaming the String class
|
|
<p>
|
|
<sect2> Case 1: Simple rename
|
|
<p>
|
|
If you do not like the String class name then you can use <bf>"typedef"</bf>
|
|
to rename the String class.
|
|
|
|
In all the files where you do include String.h, insert these lines:
|
|
<code>
|
|
// If you do not like the class name String, then you can rename using typedef
|
|
typedef String StringSomethingElseIwant;
|
|
|
|
// Your remaining code may be like this ....
|
|
int main()
|
|
{
|
|
StringSomethingElseIwant aa_renstr;
|
|
aa_renstr = "I renamed the String Class using typedef";
|
|
|
|
// .......etc...
|
|
}
|
|
</code>
|
|
See the
|
|
<url name="example_String.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Case 2: Resolve conflict
|
|
<p>
|
|
If there is a conflict with another class-name having the same name, and
|
|
you want to use both this class and conflicting class then you use this
|
|
technique -
|
|
in all the files where you do include String.h, insert these lines:
|
|
<code>
|
|
#define String String_somethingelse_which_I_want
|
|
#include "String.h"
|
|
#undef String
|
|
|
|
#include "ConflictingString.h" // This also has String class...
|
|
|
|
// All your code goes here...
|
|
int main()
|
|
{
|
|
String_somethingelse_which_I_want aa;
|
|
String bb; // This string class from conflicting string class
|
|
|
|
aa = " some sample string";
|
|
bb = " another string abraka-dabraka";
|
|
.......
|
|
}
|
|
</code>
|
|
The pre-processor will replace all literals of String
|
|
to "String_somethingelse_which_I_want" and immdiately undefines String.
|
|
After undef the conflicting string class header file is included which
|
|
defines the "String" class.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
<chapt> String.h file
|
|
-->
|
|
<sect> String.h file
|
|
<p>
|
|
In C++ (or any object oriented language), you just read the "class
|
|
data-structure" (i.e. interface) to begin using that class. You just need to
|
|
understand the interface and not the implementation of the interface. In
|
|
case of String class, you just need to read and understand the String class
|
|
in String.h file. You <bf>do not need</bf> to read the entire implementation
|
|
(String.cpp) in order to use String class. The object oriented classes are
|
|
real time saver and they <bf>very neatly hide</bf> the implementation.
|
|
|
|
(In object oriented Java language there is the equivalent called
|
|
<bf>'interface'</bf> , which hides the implementation details.)
|
|
|
|
Given below is <bf>String.h</bf> file and see also <ref id="Appendix A" name="Appendix A String.h">
|
|
<code>
|
|
//
|
|
// Author : Al Dev Email: alavoor[AT]yahoo.com
|
|
// Use string class or String class
|
|
//
|
|
// To prevent memory leaks - a char class to manage character variables
|
|
// Always prefer to use String or string class
|
|
// instead of char[] or char *
|
|
//
|
|
|
|
#ifndef __STRING_H_ALDEV_
|
|
#define __STRING_H_ALDEV_
|
|
|
|
// do not use iostream as program becomes bulky..
|
|
#ifdef NOT_MSWINDOWS
|
|
#include <iostream>
|
|
#else
|
|
#include <iostream.h> // For backward compatibility. Standard C++ Library headers have no .h
|
|
#endif // NOT_MSWINDOWS
|
|
|
|
#include <stdio.h> // for FILE and sprintf()
|
|
//#include <list.h> // for list
|
|
|
|
// For MS Windows 95 VC++ or Borland C++ compiler do -
|
|
//see file d:\program files\CBuilder\include\examples\stdlib\list.cpp and include\list.h
|
|
//#include <list> // for list
|
|
//using namespace std;
|
|
|
|
const short INITIAL_SIZE = 50;
|
|
const short NUMBER_LENGTH = 300;
|
|
const int MAX_ISTREAM_SIZE = 2048;
|
|
|
|
//class StringBuffer;
|
|
|
|
// I compiled and tested this string class on Linux (Redhat 7.1) and
|
|
// MS Windows Borland C++ version 5.2 (win32). This should also work
|
|
// using MS Visual C++ compiler
|
|
class String
|
|
{
|
|
public:
|
|
String();
|
|
String(const char bb[]); // needed by operator+
|
|
String(const char bb[], int start, int slength); // subset of chars
|
|
String(int bb); // needed by operator+
|
|
String(unsigned long bb); // needed by operator+
|
|
String(long bb); // needed by operator+
|
|
String(float bb); // needed by operator+
|
|
String(double bb); // needed by operator+
|
|
String(const String & rhs); // Copy Constructor needed by operator+
|
|
//String(StringBuffer sb); // Java compatibility - but causes compile problem on MS windows and core dumps
|
|
String(int bb, bool dummy); // for StringBuffer class
|
|
virtual ~String(); // Made virtual so that when base class is deleted
|
|
// then the derived class destructor is called.
|
|
|
|
char *val() {return sval;} // It is not safe to make sval public
|
|
|
|
// Functions below imitate Java language's String object
|
|
unsigned long length();
|
|
char charAt(int where);
|
|
void getChars(int sourceStart, int sourceEnd,
|
|
char target[], int targetStart);
|
|
char* toCharArray();
|
|
char* getBytes();
|
|
|
|
bool equals(String str2); // See also == operator
|
|
bool equals(char *str2); // See also == operator
|
|
bool equalsIgnoreCase(String str2);
|
|
|
|
bool regionMatches(int startIndex, String str2,
|
|
int str2StartIndex, int numChars);
|
|
bool regionMatches(bool ignoreCase, int startIndex,
|
|
String str2, int str2StartIndex, int numChars);
|
|
|
|
String toUpperCase();
|
|
String toLowerCase();
|
|
|
|
bool startsWith(String str2);
|
|
bool startsWith(char *str2);
|
|
|
|
bool endsWith(String str2);
|
|
bool endsWith(char *str2);
|
|
|
|
int compareTo(String str2);
|
|
int compareTo(char *str2);
|
|
int compareToIgnoreCase(String str2);
|
|
int compareToIgnoreCase(char *str2);
|
|
|
|
int indexOf(char ch, int startIndex = 0);
|
|
int indexOf(char *str2, int startIndex = 0);
|
|
int indexOf(String str2, int startIndex = 0);
|
|
|
|
int lastIndexOf(char ch, int startIndex = 0);
|
|
int lastIndexOf(char *str2, int startIndex = 0);
|
|
int lastIndexOf(String str2, int startIndex = 0);
|
|
|
|
String substring(int startIndex, int endIndex = 0);
|
|
String replace(char original, char replacement);
|
|
String replace(char *original, char *replacement);
|
|
|
|
String trim(); // See also overloaded trim()
|
|
|
|
String concat(String str2); // See also operator +
|
|
String concat(char *str2); // See also operator +
|
|
String concat(int bb);
|
|
String concat(unsigned long bb);
|
|
String concat(float bb);
|
|
String concat(double bb);
|
|
|
|
String reverse(); // See also overloaded reverse()
|
|
String deleteCharAt(int loc);
|
|
String deleteStr(int startIndex, int endIndex); // Java's "delete()"
|
|
|
|
String valueOf(char ch)
|
|
{char aa[2]; aa[0]=ch; aa[1]=0; return String(aa);}
|
|
String valueOf(char chars[]){ return String(chars);}
|
|
String valueOf(char chars[], int startIndex, int numChars);
|
|
String valueOf(bool tf)
|
|
{if (tf) return String("true"); else return String("false");}
|
|
String valueOf(int num){ return String(num);}
|
|
String valueOf(long num){ return String(num);}
|
|
String valueOf(float num) {return String(num);}
|
|
String valueOf(double num) {return String(num);}
|
|
|
|
// See also StringBuffer class in this file given below
|
|
|
|
// ---- End of Java like String object functions -----
|
|
|
|
//////////////////////////////////////////////////////
|
|
// List of additonal functions not in Java
|
|
//////////////////////////////////////////////////////
|
|
String ltrim();
|
|
void ltrim(bool dummy); // Directly changes object. dummy to get different signature
|
|
String rtrim();
|
|
void rtrim(bool dummy); // Directly changes object. See also chopall().
|
|
// dummy to get different signature
|
|
|
|
void chopall(char ch='\n'); // removes trailing character 'ch'. See also rtrim()
|
|
void chop(); // removes one trailing character
|
|
|
|
void roundf(float input_val, short precision);
|
|
void decompose_float(long *integral, long *fraction);
|
|
|
|
void roundd(double input_val, short precision);
|
|
void decompose_double(long *integral, long *fraction);
|
|
|
|
void explode(char *separator); // see also token() and overloaded explode()
|
|
String *explode(int & strcount, char separator = ' '); // see also token()
|
|
void implode(char *glue);
|
|
void join(char *glue);
|
|
String repeat(char *input, unsigned int multiplier);
|
|
String tr(char *from, char *to); // translate characters
|
|
String center(int padlength, char padchar = ' ');
|
|
String space(int number = 0, char padchar = ' ');
|
|
String xrange(char start, char end);
|
|
String compress(char *list = " ");
|
|
String left(int slength = 0, char padchar = ' ');
|
|
String right(int slength = 0, char padchar = ' ');
|
|
String overlay(char *newstr, int start = 0, int slength = 0, char padchar = ' ');
|
|
|
|
String at(char *regx); // matches first match of regx
|
|
String before(char *regx); // returns string before regx
|
|
String after(char *regx); // returns string after regx
|
|
String mid(int startIndex = 0, int length = 0);
|
|
|
|
bool isNull();
|
|
bool isInteger();
|
|
bool isInteger(int pos);
|
|
bool isNumeric();
|
|
bool isNumeric(int pos);
|
|
bool isEmpty(); // same as length() == 0
|
|
bool isUpperCase();
|
|
bool isUpperCase(int pos);
|
|
bool isLowerCase();
|
|
bool isLowerCase(int pos);
|
|
bool isWhiteSpace();
|
|
bool isWhiteSpace(int pos);
|
|
bool isBlackSpace();
|
|
bool isBlackSpace(int pos);
|
|
bool isAlpha();
|
|
bool isAlpha(int pos);
|
|
bool isAlphaNumeric();
|
|
bool isAlphaNumeric(int pos);
|
|
bool isPunct();
|
|
bool isPunct(int pos);
|
|
bool isPrintable();
|
|
bool isPrintable(int pos);
|
|
bool isHexDigit();
|
|
bool isHexDigit(int pos);
|
|
bool isCntrl();
|
|
bool isCntrl(int pos);
|
|
bool isGraph();
|
|
bool isGraph(int pos);
|
|
|
|
void clear();
|
|
int toInteger();
|
|
long parseLong();
|
|
|
|
double toDouble();
|
|
String token(char separator = ' '); // see also StringTokenizer, explode()
|
|
String crypt(char *original, char *salt);
|
|
String getline(FILE *infp = stdin); // see also putline()
|
|
//String getline(fstream *infp = stdin); // see also putline()
|
|
|
|
void putline(FILE *outfp = stdout); // see also getline()
|
|
//void putline(fstream *outfp = stdout); // see also getline()
|
|
|
|
void swap(String aa, String bb); // swap aa to bb
|
|
String *sort(String aa[]); // sorts array of strings
|
|
String sort(int startIndex = 0, int length = 0); // sorts characters inside a string
|
|
int freq(char ch); // returns the number of distinct, nonoverlapping matches
|
|
void Format(const char *fmt, ...);
|
|
String replace (int startIndex, int endIndex, String str);
|
|
|
|
void substring(int startIndex, int endIndex, bool dummy); // Directly changes object
|
|
void reverse(bool dummy); // Directly changes object. dummy to get different signature
|
|
String deleteCharAt(int loc, bool dummy); // Directly changes object
|
|
String deleteStr(int startIndex, int endIndex, bool dummy);
|
|
void trim(bool dummy); // Directly changes object. dummy to get different signature
|
|
String insert(int index, String str2);
|
|
String insert(int index, String str2, bool dummy); // Directly changes object
|
|
String insert(int index, char ch);
|
|
String insert(int index, char ch, bool dummy); // Directly changes object
|
|
String insert(char *newstr, int start = 0, int length = 0, char padchar = ' ');
|
|
|
|
String dump(); // Dump the string like 'od -c' (octal dump) does
|
|
|
|
// required by Java's StringBuffer
|
|
void ensureCapacity(int capacity);
|
|
void setLength(int len);
|
|
void setCharAt(int where, char ch); // see also charAt(), getCharAt()
|
|
|
|
// required by Java's Integer class, Long, Double classes
|
|
int parseInt(String ss) {return ss.toInteger();}
|
|
int parseInt(char *ss)
|
|
{String tmpstr(ss); return tmpstr.toInteger();}
|
|
long parseLong(String ss) {return ss.parseLong();}
|
|
long parseLong(char *ss)
|
|
{String tmpstr(ss); return tmpstr.parseLong();}
|
|
float floatValue() {return (float) toDouble(); }
|
|
double doubleValue() {return toDouble(); }
|
|
char * number2string(int bb); // see also String(int)
|
|
char * number2string(long bb); // see also String(long)
|
|
char * number2string(unsigned long bb); // see also String(long)
|
|
char * number2string(double bb); // see also String(double)
|
|
|
|
///////////////////////////////////////////////
|
|
// List of duplicate function names
|
|
///////////////////////////////////////////////
|
|
// char * c_str() // use val()
|
|
// bool find(); // Use regionMatches()
|
|
// bool search(); // Use regionMatches()
|
|
// bool matches(); // Use regionMatches()
|
|
// int rindex(String str2, int startIndex = 0); Use lastIndexOf()
|
|
// String blanks(int slength); // Use repeat()
|
|
// String append(String str2); // Use concat() or + operator
|
|
// String prepend(String str2); // Use + operator. See also append()
|
|
// String split(char separator = ' '); // Use token(), explode() or StringTokenizer class
|
|
bool contains(char *str2, int startIndex = 0); // use indexOf()
|
|
// void empty(); Use is_empty()
|
|
// void vacuum(); Use clear()
|
|
// void erase(); Use clear()
|
|
// void zero(); Use clear()
|
|
// bool is_float(); Use is_numeric();
|
|
// bool is_decimal(); Use is_numeric();
|
|
// bool is_Digit(); Use is_numeric();
|
|
// float float_value(); Use toDouble();
|
|
// float tofloat(); Use toDouble();
|
|
// double double_value(); Use toDouble();
|
|
// double numeric_value(); Use toDouble();
|
|
// int int_value(); Use toInteger()
|
|
// int tonumber(); Use toInteger()
|
|
// String get(); Use substring() or val() but prefer Java's substring
|
|
// String getFrom(); Use substring() or val() but prefer Java's substring
|
|
// String head(int len); Use substring(0, len)
|
|
// String tail(int len); Use substring(length()-len, length())
|
|
// String cut(); Use deleteCharAt() or deleteStr()
|
|
// String cutFrom(); Use deleteCharAt() or deleteStr()
|
|
// String paste(); Use insert()
|
|
// String fill(); Use replace()
|
|
// char firstChar(); // Use substring(0, 1);
|
|
// char lastChar(); // Use substring(length()-1, length());
|
|
// String findNext(); Use token(), explode() or StringTokenizer class
|
|
|
|
// begin(); iterator. Use operator [ii]
|
|
// end(); iterator. Use operator [ii]
|
|
// copy(); Use assignment = operator, String aa = bb;
|
|
// clone(); Use assignment = operator, String aa = bb;
|
|
// void putCharAt(int where, char ch); Use setCharAt()
|
|
// void replaceCharAt(int where, char ch); Use setCharAt()
|
|
// char getCharAt(int where); Use CharAt()
|
|
// void parseArgs(int where, char ch); Use StringTokensizer class, token() or explode()
|
|
// void truncate(); Use trim(), rtrim(), chop() or chopall()
|
|
// convert number to string notostring(), int2str, long2str Use number2string()
|
|
|
|
// All Operators ...
|
|
String operator+ (const String & rhs);
|
|
friend String operator+ (const String & lhs, const String & rhs);
|
|
|
|
String& operator+= (const String & rhs); // using reference will be faster
|
|
String& operator= (const String & rhs); // using reference will be faster
|
|
bool operator== (const String & rhs); // using reference will be faster
|
|
bool operator== (const char *rhs);
|
|
bool operator!= (const String & rhs);
|
|
bool operator!= (const char *rhs);
|
|
char operator [] (unsigned long Index) const;
|
|
char& operator [] (unsigned long Index);
|
|
friend ostream & operator<< (ostream & Out, const String & str2);
|
|
friend istream & operator>> (istream & In, String & str2);
|
|
|
|
bool String::operator< (const char *rhs) const; // handy methods for map & vector:
|
|
bool String::operator< (const String & rhs) const; // handy methods for map & vector:
|
|
|
|
//do later: static list<String> explodeH; // list head
|
|
|
|
protected:
|
|
char *sval; // Not safe to make sval public
|
|
void verifyIndex(unsigned long index) const; // not "inline" because MS Win32 complains
|
|
void verifyIndex(unsigned long index, char *aa) const;// not "inline" - MS Win32 complains
|
|
|
|
void _str_cat(char bb[]);
|
|
void _str_cat(int bb);
|
|
void _str_cat(unsigned long bb);
|
|
void _str_cat(float bb);
|
|
|
|
void _str_cpy(char bb[]);
|
|
void _str_cpy(int bb); // itoa
|
|
void _str_cpy(unsigned long bb);
|
|
void _str_cpy(float bb); // itof
|
|
|
|
private:
|
|
// Note: All the private variables and functions begin
|
|
// with _ (underscore)
|
|
|
|
//static String *_global_String; // for use in add operator
|
|
//inline void _free_glob(String **aa);
|
|
|
|
bool _equalto(const String & rhs, bool type = false);
|
|
bool _equalto(const char *rhs, bool type = false);
|
|
String *_pString; // temporary pointer for internal use..
|
|
char *_pNumber2String; // temporary pointer for internal use..
|
|
inline void _allocpString();
|
|
inline void _allocpNumber2String();
|
|
inline void Common2AllCstrs();
|
|
inline void _reverse();
|
|
inline void _deleteCharAt(int loc);
|
|
inline void _deleteStr(int startIndex, int endIndex);
|
|
inline void _trim();
|
|
inline void _ltrim();
|
|
inline void _rtrim();
|
|
inline void _substring(int startIndex, int endIndex);
|
|
void _roundno(double input_dbl, float input_flt, short precision, bool type);
|
|
};
|
|
|
|
// Global variables are defined in String.cpp
|
|
|
|
#endif // __STRING_H_ALDEV_
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> StringBuffer.h
|
|
<p>
|
|
<code>
|
|
//
|
|
// Author : Al Dev Email: alavoor[AT]yahoo.com
|
|
//
|
|
|
|
#ifndef __STRINGBUFFER_H_ALDEV_
|
|
#define __STRINGBUFFER_H_ALDEV_
|
|
|
|
// Imitate Java's StringBuffer object
|
|
// This class is provided so that the Java code is
|
|
// portable to C++, requiring minimum code changes
|
|
// Note: While coding in C++ DO NOT use this class StringBuffer,
|
|
// this is provided only for compiling code written in Java
|
|
// which is cut/pasted inside C++ code.
|
|
class StringBuffer: public String
|
|
{
|
|
public:
|
|
StringBuffer();
|
|
~StringBuffer();
|
|
StringBuffer(char *aa);
|
|
StringBuffer(int size);
|
|
StringBuffer(String str);
|
|
|
|
int capacity();
|
|
StringBuffer append(String str2);
|
|
// See also operator +
|
|
//{ *this += str2; return *this;} // This is causing core dumps...
|
|
|
|
StringBuffer append(char *str2);
|
|
StringBuffer append(int bb);
|
|
StringBuffer append(unsigned long bb) ;
|
|
StringBuffer append(float bb) ;
|
|
StringBuffer append(double bb) ;
|
|
|
|
StringBuffer insert(int index, String str2);
|
|
StringBuffer insert(int index, char ch);
|
|
|
|
StringBuffer reverse();
|
|
|
|
// Java's "delete()". Cannot use name delete in C++
|
|
StringBuffer deleteStr(int startIndex, int endIndex);
|
|
StringBuffer deleteCharAt(int loc);
|
|
|
|
StringBuffer substring(int startIndex, int endIndex = 0);
|
|
void assign(char *str);
|
|
|
|
private:
|
|
StringBuffer *_pStringBuffer;
|
|
inline void allocpStringBuffer();
|
|
inline void Common2AllCstrs();
|
|
};
|
|
|
|
#endif // __STRINGBUFFER_H_ALDEV_
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> StringTokenizer.h
|
|
<p>
|
|
<code>
|
|
//
|
|
// Author : Al Dev Email: alavoor[AT]yahoo.com
|
|
//
|
|
|
|
#ifndef __STRINGTOKENIZER_H_ALDEV_
|
|
#define __STRINGTOKENIZER_H_ALDEV_
|
|
|
|
// Imitate Java's StringTokenizer class
|
|
// provided to compile Java code in C++ and vice-versa
|
|
class StringTokenizer: public String
|
|
{
|
|
public:
|
|
StringTokenizer(String str);
|
|
StringTokenizer(String str, String delimiters);
|
|
StringTokenizer(String str, String delimiters, bool delimAsToken);
|
|
~StringTokenizer();
|
|
|
|
int countTokens();
|
|
bool hasMoreElements();
|
|
bool hasMoreTokens();
|
|
String nextElement(); // in Java returns type 'Object'
|
|
String nextToken();
|
|
String nextToken(String delimiters);
|
|
private:
|
|
int CurrentPosition; // current index on string
|
|
int TotalTokens;
|
|
int RemainingTokens;
|
|
char * ListOfDl; // list of delimiters
|
|
char * WorkStr; // temp work string
|
|
char * OrigStr; // original string passed
|
|
bool DlFlag; // delimiter flag
|
|
inline void vPrepWorkStr(char *delimiters = NULL);
|
|
};
|
|
|
|
#endif // __STRINGTOKENIZER_H_ALDEV_
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt change> The Standard C++ Library string class
|
|
-->
|
|
<sect> The Standard C++ Library string class <label id = "standard-string">
|
|
<p>
|
|
|
|
While the previously mentioned String class (note the uppercase S), is a
|
|
good thing for people coming from Java, then you should take notice of the
|
|
"real" string class provided by The Standard C++ Library.
|
|
|
|
The string class was made to overcome one of the greatest pitfalls in C;
|
|
character arrays. While character arrays are extremely fast, they have many
|
|
bad sides. Character arrays is the cause of many bugs, and parsing character
|
|
arrays is very time consuming.
|
|
|
|
The string class brings a good interface for parsing and handling strings,
|
|
and it's even STL compatible, so it can be used with all the general STL
|
|
algorithms. Actually you could say that a string is a
|
|
<bf>vector<char></bf>. A container of chars, or an advanced array of
|
|
chars.
|
|
|
|
Useful string reference can be found at the following sites:
|
|
<itemize>
|
|
<item>SGI STL basic_string reference: <url url="http://www.sgi.com/tech/stl/basic_string.html">.
|
|
</itemize>
|
|
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
-->
|
|
<sect1> string by example
|
|
<p>
|
|
Creating a string is easy:
|
|
<code>
|
|
#include <string>
|
|
#include <iostream>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
string str("Hello World!"); // Or string str = "Hello World!";
|
|
cout << str << endl;
|
|
}
|
|
|
|
</code>
|
|
|
|
This code will create a string called "<bf>str</bf>', and put "<bf>Hello
|
|
World!</bf>' into it. It is then being outputted to standard output by using
|
|
cout.
|
|
|
|
(Note that I will skip the headers and the namespace from now on.)
|
|
|
|
Taking a substring of a string is also easy:
|
|
<code>
|
|
string str("Hello Universe!");
|
|
string start = str.substr(0, 5);
|
|
string end = str.substr(5);
|
|
</code>
|
|
|
|
This will put the first 6 characters into the string "<bf>start</bf>", and
|
|
the rest into "<bf>end</bf>".
|
|
|
|
To get the size or length of a string, you would simply do this:
|
|
<code>
|
|
string str("How long is this string?");
|
|
cout << "Length of string is: " << str.size() << endl;
|
|
</code>
|
|
|
|
You can also use <bf>length()</bf> which works exactly the same.
|
|
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
-->
|
|
<sect1> Searching a string
|
|
<p>
|
|
Searching a string is much easier than using plain character arrays, the
|
|
string class provides efficient member functions to search through the
|
|
string. All member functions return string::size_type.
|
|
<!-- Put a line space after &lowbar below to avoid space between.... -->
|
|
<table loc=p>
|
|
<tabular ca="rll">
|
|
Member function <colsep>Purpose <rowsep>
|
|
find() <colsep>find the first position of the specified substring <rowsep>
|
|
find&lowbar
|
|
first&lowbar
|
|
of() <colsep>equal to find(), but finds the first position of any character specified<rowsep>
|
|
find&lowbar
|
|
last&lowbar
|
|
of() <colsep>equal to find_first_of(), but finds the last position of any character specified <rowsep>
|
|
find&lowbar
|
|
first&lowbar
|
|
not&lowbar
|
|
of() <colsep>equal to find_first_of(), but returns the position of the first character not of those specifed <rowsep>
|
|
find&lowbar
|
|
last&lowbar
|
|
not&lowbar
|
|
of() <colsep>equal to find_last_of(), but returns the last position of any characters not specified <rowsep>
|
|
rfind() <colsep>equal to find(), but searches backwards <rowsep>
|
|
</tabular>
|
|
<caption><bf>string search member functions</bf></caption>
|
|
</table>
|
|
|
|
A very common thing to do, is to search a string for contents. This can be done by using <bf>find()</bf>
|
|
<code>
|
|
string str("Hello, can you find Ben?");
|
|
string::size_type position = str.find("Ben");
|
|
cout << "First occurence of Ben was found at: " << position << endl;
|
|
</code>
|
|
|
|
This code make a case sensitive search for '<bf>Ben</bf>' in the string, and
|
|
put the start position in the variable '<bf>position</bf>' of type
|
|
string::size_type. Note that the return value is not an int, but a
|
|
string::size_type which is a special implementation defined integral value.
|
|
|
|
The member function <bf>find_first_of()</bf> needs a practical introduction,
|
|
consider this:
|
|
|
|
<code>
|
|
string s = "C++ is an impressive language.";
|
|
string::size_type pos = s.find_first_of(" .");
|
|
|
|
while (pos != string::npos) {
|
|
cout << "Found space or dot at: " << pos << endl;
|
|
pos = s.find_first_of(" .", pos + 1);
|
|
}
|
|
</code>
|
|
|
|
By using <bf>find_first_of()</bf>, we can search the string for <bf>any</bf>
|
|
character of the first argument, here we decide to search for a space or a
|
|
dot.
|
|
|
|
Try compiling the program and check the output.
|
|
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
-->
|
|
<sect1> A string tokenizer
|
|
<p>
|
|
A very common operation with strings, is to tokenize it with a delimiter of
|
|
your own choice. This way you can easily split the string up in smaller
|
|
pieces, without fiddling with the find() methods too much. In C, you could
|
|
use <bf>strtok()</bf> for character arrays, but no equal function exists for
|
|
strings. This means you have to make your own. Here is a couple of
|
|
suggestions, use what suits your best.
|
|
|
|
The advanced tokenizer:
|
|
<code>
|
|
void Tokenize(const string& str,
|
|
vector<string>& tokens,
|
|
const string& delimiters = " ")
|
|
{
|
|
// Skip delimiters at beginning.
|
|
string::size_type lastPos = str.find_first_not_of(delimiters, 0);
|
|
// Find first "non-delimiter".
|
|
string::size_type pos = str.find_first_of(delimiters, lastPos);
|
|
|
|
while (string::npos != pos || string::npos != lastPos)
|
|
{
|
|
// Found a token, add it to the vector.
|
|
tokens.push_back(str.substr(lastPos, pos - lastPos));
|
|
// Skip delimiters. Note the "not_of"
|
|
lastPos = str.find_first_not_of(delimiters, pos);
|
|
// Find next "non-delimiter"
|
|
pos = str.find_first_of(delimiters, lastPos);
|
|
}
|
|
}
|
|
</code>
|
|
|
|
The tokenizer can be used in this way:
|
|
<code>
|
|
#include <string>
|
|
#include <algorithm>
|
|
#include <vector>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
vector<string> tokens;
|
|
|
|
string str("Split me up! Word1 Word2 Word3.");
|
|
|
|
Tokenize(str, tokens);
|
|
|
|
copy(tokens.begin(), tokens.end(), ostream_iterator<string>(cout, ", "));
|
|
}
|
|
</code>
|
|
|
|
The above code will use the Tokenize function, take the first argument
|
|
<bf>str</bf> and split it up. And because we didn't supply a third parameter
|
|
to the function, it will use the default delimiter " ", that is - a
|
|
whitespace. All elements will be inserted into the vector <bf>tokens</bf> we
|
|
created.
|
|
|
|
In the end we copy() the whole vector to standard out, just to see the
|
|
contents of the vector on the screen.
|
|
|
|
|
|
Another approach is to let stringstreams do the work. streams in C++ have
|
|
the special ability, that they read until a whitespace, meaning the
|
|
following code works if you only want to split on spaces:
|
|
|
|
<code>
|
|
#include <vector>
|
|
#include <string>
|
|
#include <sstream>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
string str("Split me by whitespaces");
|
|
string buf; // Have a buffer string
|
|
stringstream ss(str); // Insert the string into a stream
|
|
|
|
vector<string> tokens; // Create vector to hold our words
|
|
|
|
while (ss >> buf)
|
|
tokens.push_back(buf);
|
|
}
|
|
</code>
|
|
|
|
And that's it! The stringstream will use the output operator (>>) and
|
|
put a string into <bf>buf</bf> everytime a whitespace is met, <bf>buf</bf>
|
|
is then used to push_back() into the vector. And afterwards our vector
|
|
<bf>tokens</bf> will contain all the words in <bf>str</bf>.
|
|
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt change> File Class
|
|
-->
|
|
<sect> File Class
|
|
<p>
|
|
You would use the File class to manipulate the operating system files.
|
|
This class is an imitation of Java's File class and will be very useful
|
|
in C++ programming. Using this File class in C++ you can do
|
|
if file <bf>exists()</bf> ?,
|
|
if directory <bf>exists()</bf> ?,
|
|
file <bf>length()</bf> and other functions.
|
|
|
|
Note that these classes has some great functionality not supported in The
|
|
Standard C++ Library, but don't confuse them with fstreams(iostreams), which is the
|
|
way you should perform many other operations on files.
|
|
|
|
<itemize>
|
|
<item> C++ File class is at
|
|
File.h
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/File.h">
|
|
and File.cpp
|
|
<url name="File.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
<item> Java: Java.io.File class definition <url url="http://java.sun.com/j2se/1.3/docs/api/java/io/File.html">
|
|
<item> Quick Reference on File Class <url url="http://unicornsrest.org/reference/java/qref11/java.io.File.html">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> Memory Allocation in C++ <label id="memory-allocation">
|
|
-->
|
|
<sect> Memory Allocation in C++ <label id="memory-allocation">
|
|
<p>
|
|
In C, you use malloc(), free() and variants of malloc() to allocate and free
|
|
memory, but these functions have their pitfalls. Therefor C++ introduced
|
|
operators for handling memory, these operators are called <bf>new</bf> and
|
|
<bf>delete</bf>. These operators allocates and frees memory from the heap (or
|
|
sometimes called the free store) at runtime.
|
|
|
|
In C++, you should always use <bf>new</bf> and <bf>delete</bf> unless
|
|
you're really forced to use malloc() and free(). But be aware that you
|
|
cannot mix the two. You cannot malloc() memory, and then delete it
|
|
afterwards, likewise you can't "new" memory, and then free it with free().
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> C++ Zap (Delete) function <label id="zap">
|
|
<p>
|
|
The <bf>delete</bf> and <bf>new</bf> operators in C++ are much better than
|
|
the malloc and free functions of C. Consider using new and zap (delete
|
|
function) instead of malloc and free as much as possible.
|
|
|
|
To make
|
|
<bf>delete</bf>
|
|
operators even more cleaner, make a Zap() inline function. Define
|
|
a zap() function like this:
|
|
<code>
|
|
// Put an assert to check if x is NULL, this is to catch
|
|
// program "logic" errors early. Even though delete works
|
|
// fine with NULL by using assert you are actually catching
|
|
// "bad code" very early
|
|
|
|
// Defining Zap using templates
|
|
// Use zap instead of delete as this will be very clean
|
|
template <class T>
|
|
inline void zap(T & x)
|
|
{
|
|
{assert(x != NULL);}
|
|
delete x;
|
|
x = NULL;
|
|
}
|
|
|
|
// In C++ the reason there are 2 forms of the delete operator is - because
|
|
// there is no way for C++ to tell the difference between a pointer to
|
|
// an object and a pointer to an array of objects. The delete operator
|
|
// relies on the programmer using "[]" to tell the two apart.
|
|
// Hence, we need to define zaparr function below.
|
|
// To delete array of pointers
|
|
template <class T>
|
|
inline void zaparr(T & x)
|
|
{
|
|
{assert(x != NULL);}
|
|
delete [] x;
|
|
x = NULL;
|
|
}
|
|
</code>
|
|
|
|
The zap() function will delete the pointer and set it NULL.
|
|
This will ensure that even if multiple zap()'s are called on the
|
|
same deleted pointer then the
|
|
program will not crash. Please see the function zap_example() in
|
|
<url name="example_String.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
.
|
|
|
|
<code>
|
|
// See zap_example() in example_String.cpp
|
|
zap(pFirstname);
|
|
//zap(pFirstname); // no core dumps. Because pFirstname is NULL now
|
|
//zap(pFirstname); // no core dumps. Because pFirstname is NULL now
|
|
|
|
zap(pLastname);
|
|
zap(pJobDescription);
|
|
|
|
int *iiarray = new int[10];
|
|
zaparr(iiarray);
|
|
</code>
|
|
|
|
There is nothing magical about this, it just saves
|
|
repetative code, saves typing time and makes programs more readable. The
|
|
C++ programmers often forget to reset the deleted pointer
|
|
to NULL, and this causes annoying
|
|
problems causing core dumps and crashes. The zap() takes care of
|
|
this automatically.
|
|
Do not stick a typecast in the zap() function -- if something errors out on the
|
|
above zap() function it likely has another error somewhere.
|
|
|
|
Also
|
|
<ref id="my_malloc" name="my_malloc()">
|
|
, my_realloc() and my_free() should be used
|
|
instead of malloc(), realloc() and free(), as they
|
|
are much cleaner and have additional checks.
|
|
For an example, see the file "String.h" which is using
|
|
the
|
|
<ref id="my_malloc" name="my_malloc()">
|
|
and my_free() functions.
|
|
|
|
<bf>WARNING :</bf> Do not use free() to free memory allocated with 'new'
|
|
or 'delete' to free memory allocated with malloc. If you do, then
|
|
results will be unpredictable.
|
|
|
|
See the zap examples in
|
|
<url name="example_String.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
.
|
|
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
|
|
<sect1> Usage of my_malloc and my_free <label id="my_malloc">
|
|
<p>
|
|
Try to avoid using malloc and realloc as much as possible and use <bf>new</bf>
|
|
and <bf><ref id="zap" name="zap">(delete)</bf>. But sometimes you may need to
|
|
use the C style memory allocations in C++. Use the functions
|
|
<bf>my_malloc()</bf> ,
|
|
<bf>my_realloc()</bf> and
|
|
<bf>my_free()</bf>.
|
|
These functions do proper allocations and initialisations and try to prevent
|
|
memory problems. Also these functions (in DEBUG mode) can keep track
|
|
of memory allocated and print total memory usage before and after the program
|
|
is run. This tells you if there are any memory leaks.
|
|
|
|
The my_malloc and my_realloc is defined as below. It allocates little more memory
|
|
(SAFE_MEM = 5) and initializes the space and if it cannot allocate it exits the
|
|
program. The 'call_check(), remove_ptr()' functions are active only
|
|
when DEBUG_MEM is defined in
|
|
makefile and are assigned to
|
|
((void)0) i.e. NULL
|
|
for non-debug production release. They enable the total-memory used tracing.
|
|
|
|
<code>
|
|
void *local_my_malloc(size_t size, char fname[], int lineno)
|
|
{
|
|
size_t tmpii = size + SAFE_MEM;
|
|
void *aa = NULL;
|
|
aa = (void *) malloc(tmpii);
|
|
if (aa == NULL)
|
|
raise_error_exit(MALLOC, VOID_TYPE, fname, lineno);
|
|
memset(aa, 0, tmpii);
|
|
call_check(aa, tmpii, fname, lineno);
|
|
return aa;
|
|
}
|
|
|
|
char *local_my_realloc(char *aa, size_t size, char fname[], int lineno)
|
|
{
|
|
remove_ptr(aa, fname, lineno);
|
|
unsigned long tmpjj = 0;
|
|
if (aa) // aa != NULL
|
|
tmpjj = strlen(aa);
|
|
unsigned long tmpqq = size + SAFE_MEM;
|
|
size_t tmpii = sizeof (char) * (tmpqq);
|
|
aa = (char *) realloc(aa, tmpii);
|
|
if (aa == NULL)
|
|
raise_error_exit(REALLOC, CHAR_TYPE, fname, lineno);
|
|
|
|
// do not memset memset(aa, 0, tmpii);
|
|
aa[tmpqq-1] = 0;
|
|
unsigned long kk = tmpjj;
|
|
if (tmpjj > tmpqq)
|
|
kk = tmpqq;
|
|
for ( ; kk < tmpqq; kk++)
|
|
aa[kk] = 0;
|
|
call_check(aa, tmpii, fname, lineno);
|
|
return aa;
|
|
}
|
|
</code>
|
|
See
|
|
<ref id ="Appendix A" name="my_malloc.cpp">.
|
|
and the header file
|
|
<ref id ="Appendix A" name="my_malloc.h">.
|
|
for full implementation of the my_malloc program.
|
|
|
|
An example on usage of my_malloc and my_free as below:
|
|
<code>
|
|
char *aa;
|
|
int *bb;
|
|
float *cc;
|
|
aa = (char *) my_malloc(sizeof(char)* 214);
|
|
bb = (int *) my_malloc(sizeof(int) * 10);
|
|
cc = (float *) my_malloc(sizeof(int) * 20);
|
|
|
|
aa = my_realloc(aa, sizeof(char) * 34);
|
|
bb = my_realloc(bb, sizeof(int) * 14);
|
|
cc = my_realloc(cc, sizeof(float) * 10);
|
|
</code>
|
|
Note that in my_realloc you do not need to cast the datatype as the
|
|
variable itself is passed and correct my_realloc is called which
|
|
returns the proper datatype pointer. The my_realloc has overloaded
|
|
functions for char*, int* and float*.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Garbage Collector for C++ <label id="garbage">
|
|
<p>
|
|
In C/C++ Garbage Collection is not a standard feature and hence allocating
|
|
and freeing storage explicitly is difficult, complicated and is error-prone.
|
|
The <bf>Garbage Collection (GC)</bf> is not part of the C++ standard because there
|
|
are just so many ways how one could implement it; there are many
|
|
GC techniques, and deciding to use a particular one would not
|
|
be good for certain programs. Computer scientists had designed many GC
|
|
algorithms, each one of them catering to a particular problem domain.
|
|
There is no one single generic GC which will tackle all the problem domains.
|
|
As a consequence, GC is not part of C++ standard, they just left it out.
|
|
Still, you always have the choice of many freely available C++ libraries that do
|
|
the job for you.
|
|
|
|
Visit the C++
|
|
<url name="Garbage Collection" url="http://www.xanalys.com/software_tools/mm/glossary/g.html#garbage.collection">
|
|
and <url name="Memory management" url="http://www.xanalys.com/software_tools/mm"> site.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> Pointers are problems <label id="pointers">
|
|
-->
|
|
<sect> Pointers are problems <label id="pointers">
|
|
<p>
|
|
Pointers are not required for general purpose programming. In modern
|
|
languages like Java there is no support for pointers (Java
|
|
internally uses pointers). Pointers make
|
|
the programs messy and programs using pointers are very hard to read.
|
|
|
|
Avoid using pointers as much as possible and use references. Pointers are really a
|
|
great pain. It is possible to write an application without using pointers.
|
|
<it>You should pointers only in those cases where references will not work.</it>
|
|
|
|
A <bf>reference</bf> is an alias; when you create a reference, you initialize
|
|
it with the name of another object, the target. From the moment on, the reference
|
|
acts as an alternative name of the target, and anything you do to the reference
|
|
is really done to the target.
|
|
|
|
<bf>Syntax of References:</bf> Declare a reference by writing the type, followed by
|
|
the reference operator (&), followed by the reference name. References
|
|
<bf>MUST</bf> be initialized at the time of creation.
|
|
For example -
|
|
<code>
|
|
int weight;
|
|
int & rweight = weight;
|
|
|
|
DOG aa;
|
|
DOG & rDogRef = aa;
|
|
</code>
|
|
|
|
<it>Do's</it> of references -
|
|
<itemize>
|
|
<item>Do use references to create an alias to an object
|
|
<item>Do initialize all references
|
|
<item>Do use references for high efficiency and performance of program.
|
|
<item>Do use <bf>const</bf> to protect references and pointers whenever possible.
|
|
</itemize>
|
|
|
|
<it>Do not's</it> of references -
|
|
<itemize>
|
|
<item><bf>IMPORTANT: </bf>Don't use references to NULL objects
|
|
<item>Don't confuse the address of operator & with reference operator. The references
|
|
are used in the declarations section (see Syntax of References above).
|
|
<item>Don't try to reassign a reference
|
|
<item>Don't use pointers if references will work
|
|
<item>Don't return a reference to a local object
|
|
<item>Don't pass by reference if the item referred to may go out of scope
|
|
</itemize>
|
|
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
<chapt> Debugging
|
|
-->
|
|
<sect> Debugging
|
|
<p>
|
|
Finding the exact source to a bug can be a troublesome process, however
|
|
there is several techniques used for debugging:
|
|
<itemize>
|
|
<item>Printing to standard out - for simple cases, print the values of
|
|
several variables, see what they contain - and find out where exactly your
|
|
program crashes
|
|
<item>Using a debugger, a debugger lets you set breakpoints, and make
|
|
backtraces in your code, while it's running. Most IDEs come with a debugger,
|
|
for GNU systems there is gdb.
|
|
<item>Use compiler features, on most compilers you can enable more warnings,
|
|
for example on g++, use -Wall
|
|
</itemize>
|
|
|
|
Sites to help debugging:
|
|
<itemize>
|
|
<item> Debugging C and C++ in a UNIX enironment: <url url="http://www.liacs.nl/~jdassen/onderwijs/stuva/debug/debug.html">
|
|
<item> MPatrol - a useful memory debugging tool: <url url="http://www.cbmamiga.demon.co.uk/mpatrol">
|
|
<item> NJAMD - another useful memory debuggging tool: <url url="http://sourceforge.net/projects/njamd/">
|
|
<item> LeakTracer - a simple yet powerful tool to find memory leaks: <url url="http://www.andreasen.org/LeakTracer/">
|
|
</itemize>
|
|
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Debug files
|
|
<p>
|
|
To debug any C++ or C programs include the file <ref id="Appendix A"
|
|
name="debug.h"> and in your 'Makefile' define DEBUG_STR, DEBUG_PRT,
|
|
DEBUG_MEM to turn on the traces from the debug.h functions. When you remove
|
|
the '-DDEBUG_STR' etc.. then the debug function calls are set to ((void)0)
|
|
i.e. NULL, hence it has no impact on final production release version of
|
|
project. You can generously use the debug functions in your programs and it
|
|
will not increase the size of production executable.
|
|
|
|
See the file <ref id="Appendix A" name="debug.cpp"> for implementation of
|
|
debug routines.
|
|
|
|
And see the file <ref id="Appendix A" name="my_malloc.cpp"> for a sample
|
|
which uses debug.h and debug functions.
|
|
|
|
See the sample <ref id="Appendix A" name="Makefile"> .
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> IDE's and editors for C++ <label id="idetools">
|
|
-->
|
|
<sect> IDE's and editors for C++ <label id="ide-and-editors">
|
|
<p>
|
|
When programming C++, it is a good idea to used to an editor or an IDE. Most
|
|
programmers have their own favourites, and it's a religious discussion on
|
|
which is better.
|
|
|
|
You can choose to use an IDE (Integrated Development Environment), which is
|
|
an application with embedded editor, compiler, documentation and more. And
|
|
then there is the standalone editors, which some people likes better.
|
|
|
|
<sect1> IDE's
|
|
<p>
|
|
The following IDE tools (Integrated Development Environment) are available for
|
|
C++:
|
|
<itemize>
|
|
<item> The "top rated" Dev-C++ is an full-featured Integrated Development Environment (IDE)
|
|
for both Win32 and Linux. It uses GCC, Mingw or Cygwin as compiler and libraries set.
|
|
It is at <url url="http://www.bloodshed.net/devcpp.html">
|
|
and at <url name="mirror-site" url="http://sourceforge.net/projects/dev-cpp">
|
|
<item> KDE KDevelop <url name="Kdevelop" url="http://www.kdevelop.org">
|
|
<item> Blatura site <url name="C++ Tools" url="http://home.xnet.com/~blatura/linapp6.html#tools">
|
|
<item> Amulet <url name="Amulet" url="http://www.cs.cmu.edu/afs/cs.cmu.edu/project/amulet/www">
|
|
<item> App Dev suite <url name="Angoss" url="http://www.angoss.com/sw/home.htm">
|
|
<item> Make replacement <url name="Brass" url="http://wsd.iitb.fhg.de/~kir/brashome/">
|
|
<item> S/W product metrics <url name="CCC" url="http://www.fste.ac.cowan.edu.au/~tlittlef">
|
|
<item> Project mgmt, edit, compile, debug <url name="C-Forge" url="http://www.codeforge.com">
|
|
<item> Dev environment <url name="Code Crusader" url="http://www.cco.caltech.edu/~jafl/jx/progs.html">
|
|
<item> Graphic gdb <url name="Code Medic" url="http://www.cco.caltech.edu/~glenn/medic/">
|
|
<item> Code analysis <url name="CodeWizard" url="http://www.parasoft.com/wizard/index.html">
|
|
<item> Gen HTML, LaTex for C++ cod <url name="Doc C++" url="http://www.zib.de/Visual/software/doc++/index.html">
|
|
<item> GUI toolkit openGL <url name="Ftk" url="http://fltk.easysw.com/">
|
|
<item> C++ and Java IDE <url name="GLG IDE" url="http://www.genlogic.com">
|
|
<item> HP IDE <url name="HP Eloquence" url="http://www.hp-eloquence.com/sales/info.html">
|
|
<item> IDE C++, Java, Pascal <url name="RHIDE" url="http://www.tu-chemnitz.de/~sho/rho/rhide.html">
|
|
<item> IDE for C++, Java <url name="SNiff" url="http://www.takefive.com/">
|
|
<item> IDE for C++, Java <url name="Wipeout" url="http://www.softwarebuero.de/wipeout-eng.html">
|
|
<item> X-based dev env <url name="XWPE" url="http://www.rpi.edu/~payned/xwpe">
|
|
</itemize>
|
|
|
|
<sect1> Editors
|
|
<p>
|
|
The problem with IDE's is many times that their editors have a big lack of
|
|
functionality. Therefor many people wants a powerful editor alone, and then
|
|
supply with a compiler next to it.
|
|
|
|
Of powerful editors, vim and emacs can be mentioned. They are both available
|
|
for most platforms - and they support syntax highlighting and other things
|
|
which will make you more efficient.
|
|
|
|
Other editors include UltraEdit(win32 only) and EditPlus(win32 only).
|
|
|
|
<itemize>
|
|
<item> Vim online at <url url="http://vim.sourceforge.net/">
|
|
<item> Vim color text editor for C++, C <url url="http://www.linuxdoc.org/LDP/HOWTO/Vim-HOWTO.html">
|
|
<item> Emacs at <url url="http://www.gnu.org/software/emacs/">
|
|
<item> EditPlus for Windows at <url url="http://www.editplus.com/">
|
|
<item> UltraEdit for Windows at <url url="http://www.ultraedit.com/">
|
|
</itemize>
|
|
|
|
<sect1> Other ressources
|
|
<p>
|
|
<itemize>
|
|
<item> C++ Beautifier HOWTO <url url="http://www.linuxdoc.org/LDP/HOWTO/C-C++Beautifier-HOWTO.html">
|
|
<item> Source code control system for C++ programs (CVS HOWTO) <url url="http://www.linuxdoc.org/LDP/HOWTO/CVS-HOWTO.html">
|
|
<item> Linux goodies main site is at <url url="http://www.aldev.8m.com">
|
|
Mirror sites are at -
|
|
<url name="angelfire" url="http://www.angelfire.com/country/aldev0">,
|
|
<url name="geocities" url="http://www.geocities.com/alavoor/index.html">,
|
|
<url name="virtualave" url="http://aldev0.virtualave.net">,
|
|
<url name="50megs" url="http://aldev0.50megs.com">,
|
|
<url name="theglobe" url="http://members.theglobe.com/aldev1/index.html">,
|
|
<url name="NBCi" url="http://members.nbci.com/alavoor">,
|
|
<url name="Terrashare" url="http://aldev.terrashare.com">,
|
|
<url name="Fortunecity" url="http://members.fortunecity.com/aldev">,
|
|
<url name="Freewebsites" url="http://aldev.freewebsites.com">,
|
|
<url name="Tripod" url="http://members.tripod.lycos.com/aldev">,
|
|
<url name="Spree" url="http://members.spree.com/technology/aldev">,
|
|
<url name="Escalix" url="http://www.escalix.com/freepage/aldev">,
|
|
<url name="Httpcity" url="http://www.httpcity.com/aldev/index.html">,
|
|
<url name="Freeservers" url="http://aldev.freeservers.com">.
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> C++ Online Textbooks and Docs <label id="onlinebooks">
|
|
-->
|
|
<sect> C++ Online Textbooks and Docs <label id="onlinebooks">
|
|
<p>
|
|
There are <bf>MORE THAN ONE MILLION</bf> online articles/textbooks/reference
|
|
guides on C++ language. That is because C++ is used extensively for a very
|
|
long period of time. You can find them using the Internet search engines
|
|
like Google, Yahoo, Lycos, Excite etc..
|
|
|
|
<itemize>
|
|
<item> "C++ Annotations" online book main site:<url name="Annotations" url="http://www.icce.rug.nl/documents/cplusplus">
|
|
<item>"Teach Yourself C++ in 21 days" online textbook <url name="Teach C++" url="http://guides.oernii.sk/c++/index.htm">
|
|
<item>C++ Textbook by Bruce Eckel <url name="Thinking in C++" url="http://www.mindview.net/Books/DownloadSites">
|
|
<item> C++ Open books: <url name="Panorama" url="http://www.softpanorama.org/Bookshelf/cpp.shtml"> and
|
|
click on Open Books.
|
|
<item> "Who's Afraid of C++?" online textbook: <url name="Steveheller" url="http://www.steveheller.com/whos">
|
|
<item> "Introduction to Object Oriented Programming" an ebook <url name="C++ OOP" url="http://www.gnacademy.org/uu-gna/text/cc/Tutorial/tutorial.html">
|
|
<item> C++ in Hypertext <url name="C++ Hypertext" url="http://cs.nmhu.edu/personal/curtis/cs1htmlfiles/Cs1text.htm">
|
|
<item> Object Oriented Systems <url name="OOP article" url="http://www.javaworld.com/javaworld/jw-07-1999/jw-07-toolbox_p.html">
|
|
<p>
|
|
<item>C++ Language Reference from cplusplus.com <url url="http://www.cplusplus.com/ref">
|
|
<p>
|
|
<item>C++ Documentation from cplusplus.com <url url="http://www.cplusplus.com">
|
|
<p>
|
|
<item>Common C++ Pitfalls to be avoided <url url="http://www.horstmann.com/cpp/pitfalls.html">
|
|
<p>
|
|
<item>Porting C++ to Java <url name="PortingC" url="http://www.ibm.com/java/education/portingc">
|
|
<item>C/C++ Journals <url name="UtahJournals" url="http://www.math.utah.edu/pub/tex/bib/toc/cccuj.html">
|
|
<item>Yahoo C++ category site <url name="CCyahoo" url="http://dir.yahoo.com/Computers_and_Internet/Programming_Languages/C_and_C__/C__">
|
|
<item>C Library Reference Guide<url name="c_guide" url="http://www.acm.uiuc.edu/webmonkeys/book/c_guide/index.html">
|
|
<item> Online textbooks C++/Java <url name="FreeLib" url="http://www.informit.com/free_library">
|
|
<item> "C++ In Action" by Bartosz Milewski at <url url="http://www.relisoft.com/book/index.htm">
|
|
<item> Amusing examples of how not to write code. "How to write unmaintainable code"
|
|
at <url url="http://mindprod.com/unmain.html">
|
|
</itemize>
|
|
|
|
Java books which will be useful for C++ programmers:
|
|
<itemize>
|
|
<item> Great Web reference site <url name="WebRef" url="http://www.webreference.com/index2.html">
|
|
<item> Many Java books <url name="JBooks" url="http://freewarejava.com/books/index.shtml">
|
|
<item> Intro to Java V3.0 <url name="JavaNotes" url="http://math.hws.edu/javanotes">
|
|
mirror <url name="JavaNotes" url="http://matrix.mvhs.fuhsd.org/~deruiter/javanotes3/contents.html">
|
|
<item> Web Library: <url url="http://www.itlibrary.com">
|
|
<item> Thinking in Java: <url name="Thinking Java" url="http://www.mindview.net/Books/DownloadSites">
|
|
<item> John Hopkins Univ - Java resources <url name="Hall" url="http://www.apl.jhu.edu/~hall/java">
|
|
<item> online Java tutorial <url name="Chortle" url="http://chortle.ccsu.ctstateu.edu/cs151/cs151java.html">
|
|
<item> Practical guide for Java <url name="SunBooks" url="http://java.sun.com/docs/books/tutorial/index.html">
|
|
<item> Java <url name="Soton" url="http://journals.ecs.soton.ac.uk/java/tutorial/TOC.html">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> C++ Sites
|
|
<p>
|
|
Visit the following C++ sites :-
|
|
|
|
<itemize>
|
|
<item>C++ STL basic string class documentation is at
|
|
<url url="http://www.sgi.com/tech/stl/basic_string.html">.
|
|
<item> See the section <ref id="stlref" name="STL References">
|
|
<p>
|
|
|
|
<item>C++ Crash-proof site <url url="http://www.troubleshooters.com/codecorn/crashprf.htm">
|
|
<item>C++ Memory site<url url="http://www.troubleshooters.com/codecorn/memleak.htm">
|
|
<p>
|
|
|
|
<item>GNU Main site <url url="http://www.gnu.org"> and
|
|
gnu C++ site at <url url="http://gcc.gnu.org">
|
|
<!--
|
|
Please delete all references to the 'GNU C++ Library' the document
|
|
is from 1992 and totally useless!
|
|
<item>GNU C++ Library - socs <url url="http://www.socs.uts.edu.au/doc/gnuinfo/libg++/libg++_18.html">
|
|
<item>GNU C++ Library - gsi <url url="http://www.gsi.de/doc/gnu/libg++_toc.html">
|
|
<item>GNU C++ Library - techno <url url="http://www.techno.spb.ru/~xbatob/FAQ/GNU/libg++_toc.html">
|
|
<item>GNU C++ Library - utah <url url="http://www.math.utah.edu/docs/info/libg++_toc.html">
|
|
-->
|
|
<item>AS University C++ Standard String class <url url="http://www.eas.asu.edu/~cse200/outline">
|
|
<p>
|
|
|
|
<item>Java JString for C++ <url url="http://www.mike95.com/c_plusplus/classes/JString/JString_cpp.asp">
|
|
<item>C++ Language Reference <url url="http://www.msoe.edu/~tritt/cpplang.html">
|
|
<item>C++ Program examples and samples <url url="http://www.msoe.edu/~tritt/cpp/examples.html">
|
|
<item>Neil's C++ stuff <url url="http://www.cyclone7.com/cpp">
|
|
</itemize>
|
|
|
|
Internet has vast amounts of documentation on C++. Visit the search engines
|
|
like Google, Yahoo, Lycos, Infoseek, Excite. Type in the
|
|
keywords
|
|
<bf>'C++ tutorials'</bf>
|
|
<bf>'C++ references'</bf>
|
|
<bf>'C++ books'</bf>
|
|
. You can narrow down the search criteria by clicking on <it>Advanced</it>
|
|
search and select <it>search by exact phrase</it>
|
|
|
|
<itemize>
|
|
<item> <url url="http://www.google.com">
|
|
<item> <url url="http://www.yahoo.com">
|
|
<item> <url url="http://www.lycos.com">
|
|
<item> <url url="http://www.infoseek.com">
|
|
<item> <url url="http://www.excite.com">
|
|
<item> <url url="http://www.mamma.com">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> C++ Tutorials
|
|
<p>
|
|
There are many on-line tutorials available on internet. Type 'C++ tutorials'
|
|
in the search engine.
|
|
<itemize>
|
|
<item>C++ Tutorial <url url="http://www.xploiter.com/programming/c/index.shtml">
|
|
<item>Cplusplus.com Tutorial <url url="http://www.cplusplus.com/doc/tutorial">
|
|
<item>C++ Tutorial IISc, India <url url="http://www.csa.iisc.ernet.in/Documentation/Tutorials/StyleGuides/c++-style.html">
|
|
<item>C++ Tutorial Brown Univ <url url="http://wilma.cs.brown.edu/courses/cs032/resources/C++tutorial.html">
|
|
<item>C++ Tutorial <url url="http://home.msuiit.edu.ph/~ddd/tutorials/cpp/cpplist.htm">
|
|
<item>C++ Tutorial IOstreams <url url="http://osiris.sunderland.ac.uk/~cs0pdu/pub/com365/Sched3/iocpp.html">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Useful links
|
|
<p>
|
|
<itemize>
|
|
<item>Bird's eye view of C++ URLs (about 153 url links)
|
|
<url url="http://www.enteract.com/~bradapp/links/cplusplus-links.html">
|
|
<p>
|
|
<item>This <url url="URL: http://www.snippets.org">
|
|
portable C code contains over 360 files.
|
|
<p>
|
|
<item> Mathtools at <url url="http://www.mathtools.net"> is a technical computing portal for all
|
|
scientific and engineering needs. The portal is free and contains over 20,000
|
|
useful links to technical computing programmers, covering C/C++, Java,
|
|
Excel, MATLAB, Fortran and others.
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> C++ Quick-Reference
|
|
<p>
|
|
Type 'C++ Reference' in the search engine.
|
|
<itemize>
|
|
<item>C++ quick ref <url url="http://www.cs.jcu.edu.au/~david/C++SYNTAX.html">
|
|
<item>C++ Standard Library Quick Reference <url url="http://www.halpernwightsoftware.com/stdlib-scratch/quickref.html">
|
|
<item>C++ STL from halper <url url="http://www.halpernwightsoftware.com/stdlib-scratch/quickref.html">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> C++ Usenet Newsgroups
|
|
<p>
|
|
<itemize>
|
|
<item> C++ newsgroups :
|
|
<htmlurl url="news:comp.lang.c++.announce"
|
|
name="comp.lang.c++.announce">
|
|
<item> C++ newsgroups :
|
|
<htmlurl url="news:comp.lang.c++.*"
|
|
name="comp.lang.c++.*">
|
|
<item> C++ newsgroups : <url url="http://marshall-cline.home.att.net/cpp-faq-lite">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Java like API
|
|
<p>
|
|
Visit the following sites for Java like API for C++
|
|
<itemize>
|
|
<item> Java utils in C++ <url url="http://www.pulsar.org/users/ej/archive/oop">
|
|
<item> PhD Thesis book Java API in C++ <url url="http://www.pulsar.org/archive/phd/ejphd">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> C++ Coding Conventions
|
|
-->
|
|
<sect> C++ Coding Conventions
|
|
<p>
|
|
Coding convention is very essential for readability and maintenance of programs. And
|
|
it also greatly improves the productivity of the programmer.
|
|
Coding convention is required for good coding discipline.
|
|
The following is suggested -
|
|
inside class definition:
|
|
<itemize>
|
|
<item> All public variables must begin with <bf>m</bf> like <bf>mFooVar</bf>.
|
|
The <bf>m</bf> stands for <it>member</it>.
|
|
<item> All protected variables must begin with <bf>mt</bf>,
|
|
like <bf>mtFooVar</bf> and methods with t, like <bf>tFooNum()</bf>.
|
|
The <bf>t</bf> stands for <it>protected</it>.
|
|
<item> All private variables must begin with <bf>mv</bf>, like <bf>mvFooVar</bf> and
|
|
methods with v, like <bf>vFooLone()</bf>. The <bf>v</bf> stands for <it>private</it>.
|
|
<item> All public, protected and private variables must begin with
|
|
uppercase after <bf>m</bf> like F in <bf>mFooVar</bf>.
|
|
<item> All pointer variables must be prefixed with p, like
|
|
<itemize>
|
|
<item>Public variables <bf>mpFooVar</bf> and methods like FooNum()
|
|
<item>Protected variables <bf>mtpFooVar</bf> and methods with t like tFooNum()
|
|
<item>Private variables <bf>mvpFooVar</bf> and methods with v like vFooNum()
|
|
</itemize>
|
|
</itemize>
|
|
Uniform world-wide coding convention for C++ language will help better programming.
|
|
|
|
In the sample code given below <bf>t</bf> stands for <bf>protected</bf>,
|
|
<bf>v</bf> stands for <bf>private</bf>,
|
|
<bf>m</bf> stands for <bf>member-variable</bf> and
|
|
<bf>p</bf> stands for <bf>pointer</bf>.
|
|
<code>
|
|
class SomeFunMuncho
|
|
{
|
|
public:
|
|
int mTempZimboniMacho; // Only temporary variables should be public as per OOP
|
|
float *mpTempArrayNumbers;
|
|
int HandleError();
|
|
float getBonyBox(); // Public accessor as per OOP design
|
|
float setBonyBox(); // Public accessor as per OOP design
|
|
protected:
|
|
float mtBonyBox;
|
|
int *mtpBonyHands;
|
|
char *tHandsFull();
|
|
int tGetNumbers();
|
|
private:
|
|
float mvJustDoIt;
|
|
char mvFirstName[30];
|
|
int *mvpTotalValue;
|
|
char *vSubmitBars();
|
|
int vGetNumbers();
|
|
};
|
|
</code>
|
|
When your program grows by millions of lines of code, then you will greatly
|
|
appreciate the naming convention as above. The readability of code improves,
|
|
because just by looking at the variable name like <bf>mvFirstName</bf> you can
|
|
tell that it is member of a class and is a private variable.
|
|
|
|
Visit the C++ Coding Standards URLs
|
|
<itemize>
|
|
<item> C++ FAQ Lite - Coding standards <url url="http://www.parashift.com/c++-faq-lite/coding-standards.html">
|
|
<item> Rice university coding standard <url url="http://www.cs.rice.edu/~dwallach/CPlusPlusStyle.html">
|
|
<item> Identifiers to avoid in C++ Programs <url url="http://oakroadsystems.com/tech/cppredef.htm">
|
|
<item> Coding standards from Possibility <url url="http://www.possibility.com/Cpp/CppCodingStandard.html">
|
|
and <url name="mirror site" url="http://www.cs.umd.edu/users/cml/cstyle/CppCodingStandard.html">
|
|
<item> Coding standards for Java and C++ from Ambysoft <url url="http://www.ambysoft.com/JavaCodingStandards.html">
|
|
<item> Rules and recommendations <url url="http://www.cs.umd.edu/users/cml/cstyle/">
|
|
<item> Indent and annotate <url url="http://www.cs.umd.edu/users/cml/cstyle/indhill-annot.html">
|
|
<item> Elemental rules <url url="http://www.cs.umd.edu/users/cml/cstyle/Ellemtel-rules.html">
|
|
<item> C++ style doc <url url="http://www.cs.umd.edu/users/cml/cstyle/Wildfire-C++Style.html">
|
|
<item> C++ Coding Standards by Brett Scolcum <url url="http://www.skypoint.com/~slocum/prog/cppstds.html">
|
|
<item> Logikos C++ Coding Standards <url url="http://www.logikos.com/standards/cpp_std.html">
|
|
<item> NRad C++ coding standards <url url="http://cadswes.colorado.edu/~billo/standards/nrad">
|
|
<item> BEJUG C++ coding standards <url url="http://www.meurrens.org/ip-Links/java/joodcs/ToddHoff.html">
|
|
<item> Arctic Labs coding standards <url url="http://www.arcticlabs.com/codingstandards">
|
|
<p>
|
|
See also
|
|
<item> For rapid navigation with ctags
|
|
<url name="Vim color text editor" url="http://www.linuxdoc.org/LDP/HOWTO/Vim-HOWTO.html">
|
|
<item> To improve productivity see <url name="C++ Beautifier HOWTO" url="http://www.linuxdoc.org/LDP/HOWTO/C-C++Beautifier-HOWTO.html">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
<chapt> C++ Scripting Languages
|
|
-->
|
|
<sect> C++ Scripting Languages
|
|
<p>
|
|
The major disadvantage of C++ is that you must recompile and link the object
|
|
files to create a executable anytime you make a small change. The
|
|
compile/link/debug cycles take away a lot of time and is quite unproductive.
|
|
Since modern CPU's and RAM are becoming extremely fast and cheap, it is
|
|
sometimes better to spend more money on hardware and use scripting languages
|
|
for development.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
-->
|
|
<sect1> PIKE & PHP (C/C++ Scripting Languages)
|
|
<p>
|
|
The scripting languages like PHP or PIKE eliminates the linking and re-compiling
|
|
and will really speed up the development process.
|
|
|
|
As memory (RAM) prices are dropping and CPU speeds
|
|
are increasing, scripting languages like PHP or PIKE will <bf>EXPLODE in
|
|
popularity</bf>. PHP or PIKE will become most widely used scripting language
|
|
as it is object oriented and it's syntax is very identical to that of C/C++.
|
|
|
|
|
|
Programming productivity will increase by <bf>five times</bf> by using the
|
|
PHP or Pike C++ scripting language. And PHP or PIKE is very useful for
|
|
'proof of concept' and developing prototypes rapidly.
|
|
|
|
PHP is exploding in popularity for general purpose programming and for web
|
|
development. PHP may become the most widely used scripting language in near
|
|
future. PHP is at <url url="http://www.linuxdoc.org/HOWTO/PHP-HOWTO.html">.
|
|
|
|
The Pike is at <url url="http://pike.roxen.com"> and at <url
|
|
url="http://www.roxen.com">.
|
|
|
|
The Roxen Web server is completely written in Pike, which demonstrates how
|
|
powerful Pike is. Pike runs much faster than Java for some operations and is
|
|
quite efficient in using memory resources.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
-->
|
|
<sect1> SoftIntegration Ch (C/C++ Scripting Language)
|
|
<p>
|
|
If you want commercial scripting language, get the 'Ch scripting' product from
|
|
SoftIntegration corporation at <url url="http://www.softintegration.com">.
|
|
|
|
The scripting language environment called Ch is a superset of C with
|
|
high-level extensions, and salient features from C++ and other languages so
|
|
that users can learn the language once and use it anywhere for almost any
|
|
programming purposes. This C-compatible scripting language environment is also a
|
|
middleware serving as crucial software infrastructure for running portable
|
|
applications in heterogeneous platforms. The portable Ch code can be deployed
|
|
safely over the internet or intranets to run anywhere ranging from supercomputers,
|
|
workstations, PCs, Palm Pilots, PDA, to non-traditional computing devices such
|
|
as CNC machines, robots, TVs, refrigerators, among others.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
-->
|
|
<sect1> PHP (C++ Scripting Language)
|
|
<p>
|
|
PHP is hypertext-preprocessor scripting language and is very rapidly evolving
|
|
and getting object oriented features. It has the "class" keyword through which it
|
|
tries to implement object oriented scripting. May be in near future PHP will
|
|
mature rapidly to become a robust scripting language for object oriented projects.
|
|
In future it will tackle both the web applications and general purpose applications.
|
|
Why have different scripting languages for web and general applications, instead
|
|
just use PHP for both. PHP is at <url url="http://www.linuxdoc.org/HOWTO/PHP-HOWTO.html">.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt change> Templates
|
|
-->
|
|
<sect> Templates
|
|
<p>
|
|
Templates is a feature in C++ which enables generic programming, with
|
|
templates code-reuse becomes much easier.
|
|
|
|
Consider this simple example:
|
|
|
|
<code>
|
|
#include <string>
|
|
#include <iostream>
|
|
|
|
void printstring(const std::string& str) {
|
|
std::cout << str << std::endl;
|
|
}
|
|
|
|
int main()
|
|
{
|
|
std::string str("Hello World");
|
|
printstring(str);
|
|
}
|
|
</code>
|
|
|
|
Our <bf>printstring()</bf> takes a <bf>std::string</bf> as its first
|
|
argument, therefor it can only print strings. Therefor, to print a character
|
|
array, we would either overload the function or create a function with a new
|
|
name.
|
|
|
|
This is bad, since the implementation of the function is now duplicated,
|
|
maintainability becomes harder.
|
|
|
|
With templates, we can make this code re-useable, consider this function:
|
|
|
|
<code>
|
|
template<typename T>
|
|
void print(const T& var) {
|
|
std::cout << var << std::endl;
|
|
}
|
|
</code>
|
|
|
|
The compiler will automatically generate the code for whatever type we pass
|
|
to the <bf>print</bf> function. This is the major advantage of templates.
|
|
Java doesn't have templates, and therefor generic programming and code reuse
|
|
is harder in Java.
|
|
|
|
References:
|
|
|
|
<itemize>
|
|
<item> <url url="http://babbage.cs.qc.edu/STL_Docs/templates.htm">
|
|
Mirror at: <url url="http://www.mike95.com/c_plusplus/tutorial/templates">
|
|
<p>
|
|
|
|
<item> This tells about #pragma template : -
|
|
<url url="http://www.dgp.toronto.edu/people/JamesStewart/270/9697f/notes/Nov25-tut.html">
|
|
<p>
|
|
|
|
<item> Very GOOD site:
|
|
<url url="http://www.cplusplus.com/doc/tutorial/tut5-1.html">
|
|
<url url="http://www.cplusplus.com/doc/tutorial">
|
|
<p>
|
|
|
|
<item> For certification of C++: goto <url url="http://examware.com"> and click on "Tutorials" and then C/C++ button
|
|
<p>
|
|
|
|
<item> C++ Open books: <url url="http://www.softpanorama.org/Lang/cpp.shtml">
|
|
and click on tutorials
|
|
<p>
|
|
|
|
<item> Templates tutorial : <url url="http://www.infosys.tuwien.ac.at/Research/Component/tutorial/prwmain.htm">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> STL References <label id="stlref">
|
|
-->
|
|
<sect> STL References <label id="stlref">
|
|
<p>
|
|
Please visit the following sites for STL:
|
|
<itemize>
|
|
<item> Very good intro to iterators
|
|
<url url="http://www.cs.trinity.edu/~joldham/1321/lectures/iterators/">
|
|
<item> Intro to STL SGI
|
|
<url url="http://www.sgi.com/tech/stl/stl_introduction.html">
|
|
<item> Mumits STL Newbie guide (a bit outdated)
|
|
<url url="http://www.xraylith.wisc.edu/~khan/software/stl/STL.newbie.html">
|
|
<item> ObjectSpace examples: ObjectSpace has contributed over 300 examples to the public domain and these are a very good start for beginners.
|
|
<url url="ftp://butler.hpl.hp.com/stl/examples.zip">
|
|
<item> Joseph Y. Laurino's STL page.
|
|
<url url="http://weber.u.washington.edu/~bytewave/bytewave_stl.html">
|
|
<item> Marian Corcoran's STL FAQ.
|
|
<url url="ftp://butler.hpl.hp.com/stl/stl.faq">
|
|
</itemize>
|
|
|
|
STL tutorials:
|
|
<itemize>
|
|
<item> Phil Ottewell's STL Tutorial - <url url="http://www.yrl.co.uk/~phil/stl/stl.htmlx">
|
|
<item> Good, but outdated doc - <url url="http://www.decompile.com/html/tut.html">
|
|
Mirror: <url url="http://mip.ups-tlse.fr/~grundman/stl-tutorial/tutorial.html">
|
|
<item> The Code Project, introduction to C++/STL/MFC <url url="http://www.codeproject.com/cpp/stlintroduction.asp">
|
|
<item> C++ Standard Template Library, another great tutorial, by Mark Sebern
|
|
<url url="http://www.msoe.edu/eecs/cese/resources/stl/index.htm">
|
|
<item> Technical University Vienna by Johannes Weidl <url url="http://dnaugler.cs.semo.edu/tutorials/stl">
|
|
mirror <url url="http://www.infosys.tuwien.ac.at/Research/Component/tutorial/prwmain.htm">
|
|
</itemize>
|
|
|
|
Main STL sites:
|
|
<itemize>
|
|
<item>C++ STL from SGI <url url="http://www.sgi.com/tech/stl">
|
|
<item>C++ STL from RPI univ <url url="http://www.cs.rpi.edu/projects/STL/htdocs/stl.html">
|
|
<item>C++ STL site
|
|
<url name="ODP for STL" url="http://dmoz.org/Computers/Programming/Languages/C++/Class_Libraries/STL">
|
|
and the
|
|
<url name="mirrorsite" url="http://dir.lycos.com/Computers/Programming/Languages/C%2B%2B/Class_Libraries/STL">
|
|
<item>STL for C++ Programmers <url url="http://userwww.econ.hvu.nl/~ammeraal/stlcpp.html">
|
|
<item>C++ STL from halper <url url="http://www.halpernwightsoftware.com/stdlib-scratch/quickref.html">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Overview of the STL
|
|
<p>
|
|
The STL offers the programmer a number of useful data structures and
|
|
algorithms. It is made up by the following components.
|
|
|
|
<itemize>
|
|
<item> Containers. There are two types:
|
|
<itemize>
|
|
<item> Sequential. This group comprises the vector, list and deque types.
|
|
<item> Sorted Associative. This group comprises the set, map, multiset and multimap types.
|
|
</itemize>
|
|
<p>
|
|
<item> Iterators. These are pointer like objects that allow the user to step through the contents of a container.
|
|
<p>
|
|
<item> Generic Algorithms. The STL provides a wide range of efficently implemented standard algorithms (for example find, sort
|
|
and merge) that work with the container types. (Some of the containers have special purpose implementations of these
|
|
algorithms as member functions.)
|
|
<p>
|
|
<item> Function Objects. A function object is an instance of a class that provides a definition of operator(). This means that you can
|
|
use such an object like a function.
|
|
<p>
|
|
<item> Adaptors. The STL provides
|
|
<itemize>
|
|
<item> Container adaptors that allow the user to use, say, a vector as the basis of a stack.
|
|
<item> Function adaptors that allow the user to construct new function objects from existing function objects.
|
|
</itemize>
|
|
<p>
|
|
<item> Allocators. Every STL container class uses an Allocator class to hold information about the memory model the program is
|
|
using. I shall totally ignore this aspect of the STL.
|
|
</itemize>
|
|
|
|
I will be considering the use of the vector, list, set and map containers.
|
|
To make use of these containers you have to be able to use iterators so I
|
|
shall have something to say about STL iterators. Using the set and map
|
|
containers can mean having to supply a simple function object to the
|
|
instantiation so I shall also have something to say about function objects.
|
|
I will only briefly mention the algorithms supplied by the STL. I will not
|
|
mention adaptors at all.
|
|
|
|
I have taken liberties with some of the types of function arguments -- for
|
|
example most of the integer arguments referred to in what follows actually
|
|
have type size_type which is typedef'ed to an appropriate basic type
|
|
depending on the allocation model being used. If you want to see the true
|
|
signatures of the various functions discussed have a look at the Working
|
|
Paper or the header files.
|
|
|
|
There are a number of utility classes supplied with the STL. The only one of
|
|
importance to us is the pair class. This has the following definition:
|
|
|
|
<code>
|
|
template<class T1, class T2>
|
|
class pair {
|
|
public:
|
|
T1 first;
|
|
T2 second;
|
|
pair(const T1& a, const T2& b) : first(a), second(b) {}
|
|
|
|
};
|
|
</code>
|
|
|
|
and there is a convenient function make_pair with signature:
|
|
|
|
<code>
|
|
pair<T1,T2> make_pair(const T1& f, const T2&,s)
|
|
</code>
|
|
|
|
as well as implementations of operator== and operator < . There is nothing
|
|
complicated about this template class and you should be able to use it
|
|
without further guidance. To use it #include the header file
|
|
<utility>. It crops up in a number of places but particularly when
|
|
using the set and map classes.
|
|
<sect1> Header Files
|
|
<p>
|
|
To use the various bits of the STL you have to #include the appropriate
|
|
header files. If your compiler is not standard compliant, this may differ,
|
|
but a standard compliant compiler (like g++), would have these:
|
|
|
|
<itemize>
|
|
<item> <<it>vector</it>> for the vector type.
|
|
<item> <<it>list</it>> for the list type.
|
|
<item> <<it>set</it>> for the set type.
|
|
<item> <<it>map</it>> for the map type.
|
|
<item> <<it>algorithm</it>> for access to the generic algorithms.
|
|
</itemize>
|
|
|
|
Note that headers in the Standard C++ Library is without a <bf>.h</bf>
|
|
suffix. If you use an old or poor compiler, the above headers might fail, if
|
|
then, you can try the version with the <bf>.h</bf> suffix, or better yet;
|
|
get another compiler.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> The Container Classes Interface
|
|
<p>
|
|
The container classes have many member functions that have the same names.
|
|
These functions provide the same (or very similar) interface for each of
|
|
the classes (though, of course, the implementations will be different). The
|
|
following table lists the functions that we shall consider in more detail. A
|
|
star opposite a function name indicates that the container type heading the
|
|
column provides a member function of that name.
|
|
<!--
|
|
another option is use <table>
|
|
<simplelist type="horiz" columns="2">
|
|
<member>a</member>
|
|
<member>a</member>
|
|
<member>a</member>
|
|
<member>a</member>
|
|
<member>a</member>
|
|
<member>a</member>
|
|
<member>a</member>
|
|
</simplelist>
|
|
|
|
|
|
<table loc=p>
|
|
<tabular ca="rll">
|
|
Line No.<colsep>Country <colsep>Capital <rowsep><hline>
|
|
1 <colsep>Norway <colsep>Oslo <rowsep>
|
|
2 <colsep>Japan <colsep>Tokyo <rowsep>
|
|
3 <colsep>Finland <colsep>Helsinki <rowsep>
|
|
</tabular>
|
|
<caption><bf>Some capitals</bf></caption>
|
|
</table>
|
|
-->
|
|
|
|
<!-- Put a line space after &lowbar below to avoid space between.... -->
|
|
<table loc=p>
|
|
<tabular ca="rll">
|
|
Operation <colsep>Purpose <colsep>vector <colsep>list <colsep>set <colsep>map <rowsep><hline>
|
|
== <colsep>comparison <colsep>* <colsep>*<colsep>*<colsep>*<rowsep>
|
|
<<colsep> comparison<colsep> *<colsep> *<colsep> *<colsep> *<rowsep>
|
|
begin<colsep> iterator<colsep> *<colsep> *<colsep> *<colsep> *<colsep><rowsep>
|
|
end<colsep> iterator<colsep> *<colsep> *<colsep> *<colsep> *<rowsep>
|
|
size<colsep> no. of elements<colsep> *<colsep> *<colsep> *<colsep> *<rowsep>
|
|
empty<colsep> is container empty<colsep> *<colsep> *<colsep> *<colsep> *<rowsep>
|
|
front<colsep> first element<colsep> *<colsep> *<colsep> <colsep> <rowsep>
|
|
back<colsep> last element<colsep> *<colsep> *<colsep> <colsep> <rowsep>
|
|
&lsqb &rsqb <colsep> element access/modification<colsep> *<colsep> <colsep> <colsep>*<colsep><rowsep>
|
|
insert<colsep> insert element(s)<colsep> *<colsep> *<colsep> *<colsep> *<rowsep>
|
|
|
|
push&lowbar
|
|
back<colsep> insert new last element<colsep> *<colsep> *<colsep> <colsep> <rowsep>
|
|
|
|
push&lowbar
|
|
front<colsep> insert new first element<colsep> <colsep>* <colsep> <colsep> <rowsep>
|
|
|
|
erase<colsep> remove element(s)<colsep> *<colsep> *<colsep> *<colsep> *<rowsep>
|
|
|
|
pop&lowbar
|
|
back<colsep> remove last element<colsep> *<colsep> *<colsep> <colsep> <rowsep>
|
|
|
|
pop&lowbar
|
|
front<colsep> remove first element<colsep> <colsep>*<colsep> <colsep> <rowsep>
|
|
</tabular>
|
|
<caption><bf>Container Class Interface</bf></caption>
|
|
</table>
|
|
|
|
<!--
|
|
<code>
|
|
Operation Purpose vector list set map
|
|
== comparison * * * *
|
|
< comparison * * * *
|
|
begin iterator * * * *
|
|
end iterator * * * *
|
|
size no. of elements * * * *
|
|
empty is container empty * * * *
|
|
front first element * *
|
|
back last element * *
|
|
[] element access/modification * *
|
|
insert insert element(s) * * * *
|
|
push_back insert new last element * *
|
|
push_front insert new first element *
|
|
erase remove element(s) * * * *
|
|
pop_back remove last element * *
|
|
pop_front remove first element *
|
|
</code>
|
|
-->
|
|
|
|
If the following discussion leaves something unclear
|
|
(and it will) you can always write a small test program to investigate how
|
|
some function or feature behaves.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Vectors
|
|
<p>
|
|
A vector is an array like container that improves on the C++ array types. In
|
|
particular it is not necessary to know how big you want the vector to be
|
|
when you declare it, you can add new elements to the end of a vector using
|
|
the <bf><it>push_back</it></bf> function. (In fact the
|
|
<bf><it>insert</it></bf> function allows you insert new elements at any
|
|
position of the vector, but this is a very inefficient operation -- if you
|
|
need to do this often consider using a list instead).
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Constructing Vectors
|
|
<p>
|
|
<it>vector</it> is a class template so that when declaring a vector object you have to state the type of the objects the vector is to contain. For
|
|
example the following code fragment
|
|
|
|
<code>
|
|
vector<int> v1;
|
|
vector<string> v2;
|
|
vector<FiniteAutomaton> v3;
|
|
</code>
|
|
|
|
declares that v1 is a vector that holds integers, v2 a vector that holds
|
|
strings and v3 holds objects of type FiniteAutomaton (presumably an user
|
|
defined class type). These declarations do not say anything about how large
|
|
the vectors are to be (implementations will use a default starting size) and
|
|
you can grow them to as large as you require.
|
|
|
|
You can give an initial size to a vector by using a declaration like
|
|
|
|
<code>
|
|
vector<char> v4(26);
|
|
</code>
|
|
|
|
which says that v4 is to be vector of characters that initially has room for
|
|
26 characters. There is also a way to initialise a vector's elements. The
|
|
declaration
|
|
|
|
<code>
|
|
vector<float> v5(100,1.0);
|
|
</code>
|
|
|
|
says that <it>v5</it> is a vector of 100 floating point numbers each of
|
|
which has been initialised to 1.0.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Checking Up on Your Vector
|
|
<p>
|
|
Once you have created a vector you can find out the current number of
|
|
elements it contains by using the <it>size</it> function. This function
|
|
takes no arguments and returns an integer (strictly a value of type
|
|
<it>size_type</it>, but this gets converted to an integer) which says how
|
|
many elements there are in the vector. What will be printed out by the
|
|
following small program?
|
|
|
|
<code>
|
|
<vector-size.cpp>=
|
|
#include <iostream>
|
|
#include <vector>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
vector<int> v1;
|
|
vector<int> v2(10);
|
|
vector<int> v3(10,7);
|
|
|
|
cout << "v1.size() returns " << v1.size() << endl;
|
|
cout << "v2.size() returns " << v2.size() << endl;
|
|
cout << "v3.size() returns " << v3.size() << endl;
|
|
}
|
|
</code>
|
|
|
|
To check on whether your vector is empty or not you can use the empty
|
|
function. This takes no arguments and returns a boolean value, true if the
|
|
vector is empty, false if it is not empty. What will be printed out by the
|
|
following small program (true prints as 1 and false prints as 0)?
|
|
|
|
<code>
|
|
<vector-empty.cpp>=
|
|
#include <iostream>
|
|
#include <vector>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
vector<int> v1;
|
|
vector<int> v2(10);
|
|
vector<int> v3(10,7);
|
|
|
|
cout << "v1.empty() has value " << v1.empty() << endl;
|
|
cout << "v2.empty() has value " << v2.empty() << endl;
|
|
cout << "v3.empty() has value " << v3.empty() << endl;
|
|
}
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Accessing Elements of a Vector
|
|
<p>
|
|
You can access a vector's elements using operator[]. Thus, if you wanted to print out all the elements in a vector you could use code
|
|
like
|
|
|
|
<code>
|
|
vector<int> v;
|
|
// ...
|
|
for (int i=0; i<v.size(); i++)
|
|
cout << v[i];
|
|
</code>
|
|
|
|
(which is very similar to what you might write for a builtin array).
|
|
|
|
You can also use operator[] to set the values of the elements of a vector.
|
|
|
|
<code>
|
|
vector<int> v;
|
|
// ...
|
|
for (int i=0; i<v.size(); i++)
|
|
v[i] = 2*i;
|
|
</code>
|
|
|
|
The function front gives access to the first element of the vector.
|
|
|
|
<code>
|
|
vector<char> v(10,'a');
|
|
// ...
|
|
char ch = v.front();
|
|
</code>
|
|
|
|
You can also change the first element using front.
|
|
|
|
<code>
|
|
vector<char> v(10,'a');
|
|
// ...
|
|
v.front() = 'b';
|
|
</code>
|
|
|
|
The function back works the same as front but for the last element of the vector.
|
|
|
|
<code>
|
|
vector<char> v(10,'z');
|
|
// ...
|
|
char last = v.back();
|
|
v.back() = 'a';
|
|
</code>
|
|
|
|
Here is a simple example of the use of [].
|
|
|
|
<code>
|
|
<vector-access.cpp>=
|
|
#include <vector>
|
|
#include <iostream>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
vector<int> v1(5);
|
|
int x;
|
|
cout << "Enter 5 integers (seperated by spaces):" << endl;
|
|
for (int i=0; i<5; i++)
|
|
cin >> v1[i];
|
|
cout << "You entered:" << endl;
|
|
for (int i=0; i<5; i++)
|
|
cout << v1[i] << ' ';
|
|
cout << endl;
|
|
}
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Inserting and Erasing Vector Elements
|
|
<p>
|
|
Along with operator[] as described above there are a number of other ways to change or access the elements in a vector.
|
|
|
|
<itemize>
|
|
<item>push_back will add a new element to the end of a vector.
|
|
<item>pop_back will remove the last element of a vector.
|
|
<item>insert will insert one or more new elements, at a designated position, in the vector.
|
|
<item>erase will remove one or more elements from a vector between designated positions.
|
|
</itemize>
|
|
|
|
Note that insert and erase are expensive operations on vectors. If you use them a lot then you should consider using the list data
|
|
structure for which they are more efficient.
|
|
|
|
<code>
|
|
<vector-mod.cpp>=
|
|
#include <iostream>
|
|
#include <vector>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
vector<int> v;
|
|
|
|
for (int i=0; i<10; i++) v.push_back(i);
|
|
cout << "Vector initialised to:" << endl;
|
|
for (int i=0; i<10; i++) cout << v[i] << ' ' ;
|
|
cout << endl;
|
|
|
|
for (int i=0; i<3; i++) v.pop_back();
|
|
cout << "Vector length now: " << v.size() << endl;
|
|
cout << "It contains:" << endl;
|
|
for (int i=0; i<v.size(); i++) cout << v[i] << ' ';
|
|
cout << endl;
|
|
|
|
int a1[5];
|
|
for (int i=0; i<5; i++) a1[i] = 100;
|
|
|
|
v.insert(& v[3], & a1[0],& a1[3]);
|
|
cout << "Vector now contains:" << endl;
|
|
for (int i=0; i<v.size(); i++) cout << v[i] << ' ';
|
|
cout << endl;
|
|
|
|
v.erase(& v[4],& v[7]);
|
|
cout << "Vector now contains:" << endl;
|
|
for (int i=0; i<v.size(); i++) cout << v[i] << ' ';
|
|
cout << endl;
|
|
}
|
|
</code>
|
|
|
|
In the above a vector v has been declared then initialised using push_back.
|
|
Then some elements have been trimmed off it's end using pop_back. Next an
|
|
ordinary integer array has been created and then some of its elements
|
|
inserted into v using insert. Finally erase has been used to remove elements
|
|
from v. The functions used above take arguments as follows.
|
|
|
|
<itemize>
|
|
<item> push_back takes a single argument of the type of the elements held in the vector.
|
|
<item> pop_back takes no arguments. It is a mistake to use pop_back on an empty vector.
|
|
<item> insert has three forms:
|
|
<itemize>
|
|
<item>insert(pos, T& x) which will insert the single element x at position pos in the vector.
|
|
<item>insert(pos, start, end) which inserts a sequence of elements from some other container at position pos in the vector. The
|
|
<item>sequence of elements is identified as starting at the start element and continuing to, but not including, the end element.
|
|
<item>insert(pos, int rep, T& x) inserts rep copies of x at position pos in the vector.
|
|
</itemize>
|
|
</itemize>
|
|
As indicated in the code above the position pos should be the address of the element to insert at, whilst the start and end
|
|
arguments are likewise also addresses. (The true story is that they are iterators -- see next subsection and following
|
|
section).
|
|
<itemize>
|
|
<item> erase has two forms (pos, start and end have the same types as for the insert function):
|
|
<itemize>
|
|
<item> erase(pos) which will remove the element at position pos in the vector.
|
|
<item> insert(start,end) which will remove elements starting at position start upto, but not including, the element at position end.
|
|
</itemize>
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Vector Iterators
|
|
<p>
|
|
|
|
The simple way to step through the elements of a vector v is as we have done above:
|
|
|
|
<code>
|
|
for (int i=0; i<v.size(); i++) { ... v[i] ... }
|
|
</code>
|
|
|
|
Another way is to use iterators. An iterator can be thought of as a pointer into the container, incrementing the iterator allows you
|
|
to step through the container. For container types other than vectors iterators are the only way to step through the container.
|
|
|
|
For a vector containing elements of type T:
|
|
|
|
<code>
|
|
vector<T> v;
|
|
</code>
|
|
|
|
an iterator is declared as follows:
|
|
|
|
<code>
|
|
vector<T>::iterator i;
|
|
</code>
|
|
|
|
Such iterators are constructed and returned by the functions begin() and end(). You can compare two iterators (of the same type)
|
|
using == and !=, increment using ++ and dereference using *. [In fact vector iterators allow more operations on them - see next
|
|
section for more information].
|
|
|
|
Here is an illustration of how to use iterators with vectors.
|
|
|
|
<code>
|
|
<vector-iterator.cpp>=
|
|
#include <iostream>
|
|
#include <vector>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
vector<int> v(10);
|
|
// first is ``less'' than the second
|
|
|
|
int j = 1;
|
|
|
|
vector<int>::iterator i;
|
|
|
|
// Fill the vector v with integers 1 to 10.
|
|
i = v.begin();
|
|
while (i != v.end())
|
|
{
|
|
*i = j;
|
|
j++;
|
|
i++;
|
|
}
|
|
|
|
// Square each element of v.
|
|
for (i=v.begin(); i!=v.end(); i++) *i = (*i) * (*i);
|
|
|
|
// Print out the vector v.
|
|
cout << "The vector v contains: ";
|
|
for (i=v.begin(); i!=v.end(); i++) cout << *i << ' ';
|
|
cout << endl;
|
|
|
|
}
|
|
</code>
|
|
|
|
Note how *i can be used on the left-hand side of an assignment statement so as to update the element pointed at by i, and on the
|
|
right-hand side to access the current value.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Comparing Vectors
|
|
<p>
|
|
You can compare two vectors using == and <. == will return true only if both vectors have the same number of elements and all
|
|
elements are equal. The < functions performs a lexicographic comparison of the two vectors. This works by comparing the vectors
|
|
element by element. Suppose we are comparing v1 and v2 (that is
|
|
v1 < v2?). Set i=0. If v1[i] < v2[i] then return true, if v1[i] > v2[i] then
|
|
return false, otherwise increment i (that is move on to the next element). If the end of v1 is reached before v2 return true, otherwise
|
|
return false. Lexicographic order is also known as dictionary order. Some examples:
|
|
|
|
<code>
|
|
(1,2,3,4) < (5,6,7,8,9,10) is false.
|
|
(1,2,3) < (1,2,3,4) is true
|
|
(1,2,3,4) < (1,2,3) is false
|
|
(0,1,2,3) < (1,2,3) is true
|
|
</code>
|
|
|
|
The following code illustrates the third example above.
|
|
|
|
<code>
|
|
<vector-comp.cpp>=
|
|
#include <vector>
|
|
#include <iostream>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
vector<int> v1;
|
|
vector<int> v2;
|
|
for (int i=0; i<4; i++) v1.push_back(i+1);
|
|
for (int i=0; i<3; i++) v2.push_back(i+1);
|
|
|
|
cout << "v1: ";
|
|
for (int i=0; i<v1.size(); i++) cout << v1[i] << ' ';
|
|
cout << endl;
|
|
|
|
cout << "v2: ";
|
|
for (int i=0; i<v2.size(); i++) cout << v2[i] << ' ';
|
|
cout << endl;
|
|
|
|
cout << "v1 < v2 is: " << (v1<v2 ? "true" : "false") << endl;
|
|
}
|
|
</code>
|
|
The comparison operators <= and >= also work.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Iterators and the STL
|
|
<p>
|
|
See the section <ref id="stlref" name="STL References">
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Lists
|
|
<p>
|
|
See the section <ref id="stlref" name="STL References">
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Sets
|
|
<p>
|
|
The set container type allows an user to store and retrieve elements directly rather than through an index into the container. The set container acts as a mathematical set in that it holds
|
|
only distinct elements. However unlike a mathematical set, elements in a set
|
|
container are held in (an user-supplied) order. In practice this is only a minor restriction on treating a set
|
|
container as an implementation of the mathematical set abstract data type,
|
|
and it allows for a much more efficient implementation than an unordered approach.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Constructing Sets
|
|
<p>
|
|
Two template arguments are required to construct a set container -- the type of the objects the set is to contain and a function object that can compare two elements of the given type,
|
|
that is:
|
|
|
|
<code>
|
|
set<T, Compare> s;
|
|
</code>
|
|
|
|
(The declaration <it>set < T > s</it> should also be possible -- it would
|
|
use a default template argument less < T > as the second argument, but
|
|
many C++ compilers (including g++) cannot as
|
|
yet cope with default template arguments.)
|
|
|
|
For simple types <bf>T</bf> we can use the function object <it>less < T > </it> (
|
|
without having to worry about what a ``function object'' is), for example all the following are legal set declarations.
|
|
|
|
<code>
|
|
set<int, less<int> > s1;
|
|
set<double, less<double> > s2;
|
|
set<char, less<char> > s3;
|
|
set<string, less<string> > s4;
|
|
</code>
|
|
|
|
(Note that the space between the two final >'s in the template is required - otherwise the compiler will interpret >> as the right shift operator.) In each of these cases the function
|
|
object makes use of the operator < as defined for the the underlying type (that is
|
|
<it>int, double, char</it> and <it>string</it>).
|
|
|
|
The following code declares a set of integers, then adds some integers to
|
|
the set using the <it>insert</it> method and then prints out the set
|
|
members by iterating through the set. You will
|
|
note that the set's contents are printed out in ascending order even though they were added in no particular order.
|
|
|
|
<code>
|
|
<set-construct1.cpp>=
|
|
#include <iostream>
|
|
#include <set>
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
set<int, less<int> > s;
|
|
set<int, less<int> >::iterator i;
|
|
|
|
s.insert(4);
|
|
s.insert(0);
|
|
s.insert(-9);
|
|
s.insert(7);
|
|
s.insert(-2);
|
|
s.insert(4);
|
|
s.insert(2);
|
|
|
|
cout << "The set contains the elements: ";
|
|
for (i=s.begin(); i!=s.end(); i++) cout << *i << ' ';
|
|
cout << endl;
|
|
}
|
|
</code>
|
|
|
|
Note that 4 is added twice but only turns up once on the list of elements -- which is what one expects of a set.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> What are Function Objects?
|
|
<p>
|
|
|
|
One of the nifty features of C++ is the ability to overload operators, so that one can have + mean whatever one likes for your newly designed class. One of the operators C++ allows
|
|
you to overload is the function call operator () and this allows you to create classes whose instances can behave like functions in many ways. These are function objects.
|
|
|
|
Here is a simple example.
|
|
|
|
<code>
|
|
<function-object.cpp>=
|
|
#include <iostream>
|
|
|
|
using namespace std;
|
|
|
|
template<class T>
|
|
class square {
|
|
public:
|
|
T operator()(T x) { return x*x; }
|
|
};
|
|
// This can be used with any T for which * is defined.
|
|
|
|
int main()
|
|
{
|
|
// Create some function objects.
|
|
square<double> f1;
|
|
square<int> f2;
|
|
|
|
// Use them.
|
|
cout << "5.1^2 = " << f1(5.1) << endl;
|
|
cout << "100^2 = " << f2(100) << endl;
|
|
|
|
// The following would result in a compile time error.
|
|
// cout << "100.1^2 = " << f2(100.1) << endl;
|
|
}
|
|
</code>
|
|
|
|
Function objects are used in a number of places in the STL. In particular they are used when declaring sets and maps.
|
|
|
|
The function object required for these purposes, let's suppose it is
|
|
called <it>comp</it>, must satisfy the following requirements.
|
|
|
|
<enum>
|
|
<item> If comp(x,y) and comp(y,z) are true for objects x, y and z then comp(x,z) is also true.
|
|
<item> comp(x,x) is false for every object x.
|
|
</enum>
|
|
|
|
If for any particular objects x and y, both comp(x,y) and comp(y,x) are false then x and y are deemed to be equal.
|
|
|
|
This, in fact, is just the behaviour of the <it>strictly-less-than</it>
|
|
relation (ie < ) on numbers. The function object less < T > used above is
|
|
defined in terms of a < operator for the type T. It's
|
|
definition can be thought of as follows.
|
|
|
|
<code>
|
|
template<class T>
|
|
struct less {
|
|
bool operator()(T x, T y) { return x<y; }
|
|
}
|
|
</code>
|
|
|
|
(The actual definition uses references, has appropriate const annotations and inherits from a template class binary_function.)
|
|
|
|
This means that if the type T has operator < defined for it then you can use
|
|
less < T > as the comparator when declaring sets of T. You might still want to use a special purpose
|
|
comparator if the supplied < operator is not appropriate for
|
|
your purposes. Here is another example. This defines a simple
|
|
class with a definition of operator < and a function object
|
|
that performs a different comparison. Note that the overloaded <
|
|
and () operators should be given const annotations so that the functions
|
|
work correctly with the STL.
|
|
|
|
<code>
|
|
<set-construct2.cpp>=
|
|
#include <iostream>
|
|
#include <set>
|
|
|
|
using namespace std;
|
|
|
|
// This class has two data members. The overloaded operator< compares
|
|
// such classes on the basis of the member f1.
|
|
class myClass {
|
|
private:
|
|
int f1;
|
|
char f2;
|
|
public:
|
|
myClass(int a, char b) : f1(a), f2(b) {}
|
|
int field1() const { return f1; }
|
|
char field2() const { return f2; }
|
|
bool operator<(myClass y) const
|
|
{ return (f1<y.field1()); }
|
|
};
|
|
|
|
// This function object compares objects of type myClass on the basis
|
|
// of the data member f2.
|
|
class comp_myClass {
|
|
public:
|
|
bool operator()(myClass c1, myClass c2) const
|
|
{ return (c1.field2() < c2.field2()); }
|
|
};
|
|
|
|
int main()
|
|
{
|
|
set<myClass, less<myClass> > s1;
|
|
set<myClass, less<myClass> >::iterator i;
|
|
set<myClass, comp_myClass> s2;
|
|
set<myClass, comp_myClass>::iterator j;
|
|
|
|
s1.insert(myClass(1,'a'));
|
|
s2.insert(myClass(1,'a'));
|
|
s1.insert(myClass(1,'b'));
|
|
s2.insert(myClass(1,'b'));
|
|
s1.insert(myClass(2,'a'));
|
|
s2.insert(myClass(2,'a'));
|
|
|
|
cout << "Set s1 contains: ";
|
|
for (i=s1.begin(); i!=s1.end(); i++)
|
|
{
|
|
cout << "(" << (*i).field1() << ","
|
|
<< (*i).field2() << ")" << ' ';
|
|
}
|
|
cout << endl;
|
|
|
|
cout << "Set s2 contains: ";
|
|
for (j=s2.begin(); j!=s2.end(); j++)
|
|
{
|
|
cout << "(" << (*j).field1() << ","
|
|
<< (*j).field2() << ")" << ' ';
|
|
}
|
|
cout << endl;
|
|
}
|
|
</code>
|
|
|
|
The set s1 contains (1,a) and (2,a) as comparison is on the data member f1, so that (1,a) and (1,b) are deemed the same element. The set s2 contains (1,a) and (1,b) as
|
|
comparison is on the data member f2, so that (1,a) and (2,a) are deemed the same element.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> A Printing Utility
|
|
<p>
|
|
The way we have printed out the sets in the previous examples is a little awkward so the following header file containing a simple overloaded version
|
|
of <it>operator<< </it> has been written.
|
|
It works fine for small sets with simple element types.
|
|
|
|
<code>
|
|
<printset.h>=
|
|
#ifndef _PRINTSET_H
|
|
#define _PRINTSET_H
|
|
|
|
#include <iostream>
|
|
#include <set>
|
|
|
|
template<class T, class Comp>
|
|
std::ostream& operator<<(std::ostream& os, const std::set<T,Comp>& s)
|
|
{
|
|
std::set<T,Comp>::iterator iter = s.begin();
|
|
int sz = s.size();
|
|
int cnt = 0;
|
|
|
|
os << "{";
|
|
while (cnt < sz-1)
|
|
{
|
|
os << *iter << ",";
|
|
iter++;
|
|
cnt++;
|
|
}
|
|
if (sz != 0) os << *iter;
|
|
os << "}";
|
|
|
|
return os;
|
|
}
|
|
#endif
|
|
</code>
|
|
|
|
The use here of << as an output routine for a set assumes that << has been defined for the set elements, and uses this to print a comma delimited list of the set elements wrapped in
|
|
curly braces. It will be used without comment in the following examples.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> How Many Elements?
|
|
<p>
|
|
|
|
You can determine if a set is empty or not by using the empty() method. You can find out how many elements there are in a set by using the size() method. These methods take no
|
|
arguments, empty() returns true or false and size() returns an integer.
|
|
|
|
<code>
|
|
<set-size.cpp>=
|
|
#include <iostream>
|
|
#include <set>
|
|
#include "printset.h"
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
set<int, less<int> > s;
|
|
|
|
cout << "The set s is "
|
|
<< (s.empty() ? "empty." : "non-empty.") << endl;
|
|
cout << "It has " << s.size() << "elements." << endl;
|
|
|
|
cout << "Now adding some elements... " << endl;
|
|
|
|
s.insert(1);
|
|
s.insert(6);
|
|
s.insert(7);
|
|
s.insert(-7);
|
|
s.insert(5);
|
|
s.insert(2);
|
|
s.insert(1);
|
|
s.insert(6);
|
|
|
|
cout << "The set s is now
|
|
<< (s.empty() ? "empty." : "non-empty.") << endl;
|
|
cout << "It has " << s.size() << "elements." << endl;
|
|
cout << "s = " << s << endl;
|
|
}
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Checking the Equality of Sets.
|
|
<p>
|
|
Two sets may be checked for equality by using ==. This equality test works by testing in order the corresponding elements of each set for equality using T::operator==.
|
|
|
|
<code>
|
|
<set-equality.cpp>=
|
|
#include <iostream>
|
|
#include <set>
|
|
#include "printset.h"
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
set<int, less<int> > s1, s2 ,s3;
|
|
|
|
for (int i=0; i<10; i++)
|
|
{
|
|
s1.insert(i);
|
|
s2.insert(2*i);
|
|
s3.insert(i);
|
|
}
|
|
|
|
cout << "s1 = " << s1 << endl;
|
|
cout << "s2 = " << s2 << endl;
|
|
cout << "s3 = " << s3 << endl;
|
|
cout << "s1==s2 is: " << (s1==s2 ? true. : false.) << endl;
|
|
cout << "s1==s3 is: " << (s1==s3 ? true. : false.) << endl;
|
|
}
|
|
</code>
|
|
|
|
It is also possible to compare two sets using <. The comparison s1 < s2 is true if the set s1 is lexicographically less than the set s2, otherwise it is false.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Adding and Deleting Elements
|
|
<p>
|
|
The way to add elements to a set is to use the insert method (as we have done above). The way to delete elements from a set is to use the erase method.
|
|
|
|
For a set holding elements of type T these methods come in following forms:
|
|
<itemize>
|
|
<item> <bf>pair < iterator, bool> insert(T& x)</bf>. This is the standard insert function. The return value may be ignored or used to test if the insertion succeeded (that is the element
|
|
was not already in the set). If the insertion succeeded the boolean component will be true and the iterator will point at the just inserted element. If the element is already
|
|
present the boolean component will be false and the iterator will point at the element x already present.
|
|
<p>
|
|
<item> <bf>iterator insert(iterator position, T& x)</bf>. This version of the insert function takes, in addition to the element to insert, an iterator stating where the insert function
|
|
should begin to search. The returned iterator points at the newly inserted element, (or the already present element).
|
|
<p>
|
|
<item> <bf>int erase(T& x)</bf>. This version of the erase method takes an element to delete and returns 1 if the element was present (and removes it) or 0 if the element was not present.
|
|
<p>
|
|
<item> <bf>void erase(iterator position)</bf>. This version takes an iterator pointing at some element in the set and removes that element.
|
|
<p>
|
|
<item> <bf>void erase(iterator first, iterator last)</bf>. This version takes two
|
|
iterators pointing into the set and removes all the elements in the range &lsqb first,last &rsqb .
|
|
</itemize>
|
|
|
|
The following example illustrates these various forms.
|
|
|
|
<code>
|
|
<set-add-delete.cpp>=
|
|
#include <iostream>
|
|
#include <set>
|
|
#include "printset.h"
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
set<int, less<int> > s1;
|
|
|
|
// Insert elements in the standard fashion.
|
|
s1.insert(1);
|
|
s1.insert(2);
|
|
s1.insert(-2);
|
|
|
|
// Insert elements at particular positions.
|
|
s1.insert(s1.end(), 3);
|
|
s1.insert(s1.begin(), -3);
|
|
s1.insert((s1.begin()++)++, 0);
|
|
|
|
cout << "s1 = " << s1 << endl;
|
|
|
|
// Check to see if an insertion has been successful.
|
|
pair<set<int, less<int> >::iterator,bool> x = s1.insert(4);
|
|
cout << "Insertion of 4 " << (x.second ? worked. : failed.)
|
|
<< endl;
|
|
x = s1.insert(0);
|
|
cout << "Insertion of 0 " << (x.second ? worked. : failed.)
|
|
<< endl;
|
|
|
|
// The iterator returned by insert can be used as the position
|
|
// component of the second form of insert.
|
|
cout << "Inserting 10, 8 and 7." << endl;
|
|
s1.insert(10);
|
|
x=s1.insert(7);
|
|
s1.insert(x.first, 8);
|
|
|
|
cout << "s1 = " << s1 << endl;
|
|
|
|
// Attempt to remove some elements.
|
|
cout << "Removal of 0 " << (s1.erase(0) ? worked. : failed.)
|
|
<< endl;
|
|
cout << "Removal of 5 " << (s1.erase(5) ? worked. : failed.)
|
|
<< endl;
|
|
|
|
// Locate an element, then remove it. (See below for find.)
|
|
cout << "Searching for 7." << endl;
|
|
set<int,less<int> >::iterator e = s1.find(7);
|
|
cout << "Removing 7." << endl;
|
|
s1.erase(e);
|
|
|
|
cout << "s1 = " << s1 << endl;
|
|
|
|
// Finally erase everything from the set.
|
|
cout << "Removing all elements from s1." << endl;
|
|
s1.erase(s1.begin(), s1.end());
|
|
cout << "s1 = " << s1 << endl;
|
|
cout << "s1 is now " << (s1.empty() ? empty. : non-empty.)
|
|
<< endl;
|
|
}
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Finding Elements
|
|
<p>
|
|
|
|
We mention two member functions that can be used to test if an element is present in a set or not.
|
|
|
|
<itemize>
|
|
<item> <bf>iterator find(T& x)</bf>. This searches for the element x in the set. If x is found it returns an iterator pointing at x otherwise it returns end().
|
|
<item> <bf>int count(T& x)</bf>. This returns 1 if it finds x in the set and 0 otherwise. (The count function for multisets returns the number of copies of the element in the set which may be
|
|
more than 1. Hence, I guess, the name of the function.)
|
|
</itemize>
|
|
|
|
The use of find has been illustrated above. We could use count to write a simple template based set membership function. (This should also provide a version that takes a reference
|
|
to the argument x.)
|
|
|
|
<code>
|
|
<setmember.h>=
|
|
#ifndef _SETMEMBER_H
|
|
#define _SETMEMBER_H
|
|
#include <set>
|
|
|
|
template<class T, class Comp>
|
|
bool member(T x, std::set<T,Comp>& s)
|
|
{
|
|
return (s.count(x)==1 ? true : false);
|
|
}
|
|
#endif
|
|
|
|
Which might be used as follows.
|
|
|
|
<set-membership.cpp>=
|
|
#include <iostream>
|
|
#include <set>
|
|
#include "printset.h"
|
|
#include "setmember.h"
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
set<int, less<int> > s;
|
|
for (int i= 0; i<10; i++) s.insert(i);
|
|
cout << "s = " << s << endl;
|
|
cout << "1 is " << (member(1,s) ? : not) << " a member of s "
|
|
<< endl;
|
|
cout << "10 is " << (member(10,s) ? : not) << " a member of s "
|
|
<< endl;
|
|
}
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Set Theoretic Operations
|
|
<p>
|
|
|
|
The STL supplies as generic algorithms the set operations includes, union, intersection, difference and symmetric diffference. To gain access to these functions you need to include
|
|
algo.h. (In what follows iter stands for an appropriate iterator).
|
|
|
|
<itemize>
|
|
<item> bool includes(iter f1,iter l1,iter f2,iter l2).
|
|
<p>
|
|
This checks to see if the set represented by the range [f2,l2] is included in the set [f1,l1]. It returns true if it is and false otherwise. So to check to see if one set is
|
|
included in another you would use
|
|
|
|
<p>
|
|
includes(s1.begin(), s1.end(), s2.begin(), s2.end())
|
|
<p>
|
|
The includes function checks the truth of 3#3 ( that is of 4#4). This function assumes that the sets are ordered using the comparison operator <. If some other comparison
|
|
operator has been used this needs to be passed to includes as an extra (function object) argument after the other arguments.
|
|
<p>
|
|
<item> iter set_union(iter f1,iter l1,iter f2,iter l2,iter result).
|
|
<p>
|
|
This forms the union of the sets represented by the ranges [f1,l1] and [f2,l2]. The argument result is an output iterator that points at the start of the set that is going to
|
|
hold the union. The return value of the function is an output iterator that points at the end of the new set.
|
|
</itemize>
|
|
|
|
The fact that the result argument is an output iterator means that you cannot use set_union in the following, natural, fashion:
|
|
|
|
<code>
|
|
set<int, less<int> > s1, s2, s3;
|
|
// Add some elements to s1 and s2 ...
|
|
// Then form their union. (This does not work!)
|
|
set_union(s1.begin(), s1.end(),
|
|
s2.begin(), s2.end(),
|
|
s3.begin());
|
|
</code>
|
|
|
|
The reason is that begin() (also end()) when used with sets (or maps) returns a (constant) input iterator. This type of iterator allows you to access elements of the set for
|
|
reading but not writing. (And this is a Good Thing since if you could assign to a dereferenced iterator (as in (*i)= ...) then you could destroy the underlying order of the
|
|
set.)
|
|
|
|
The solution is to use an insert iterator based on the set type. This, basically, converts an assignment (*i)=value (which is illegal) into a (legal) insertion
|
|
s.insert(i,value) (where s is the set object that the iterator i is pointing into). It is used as follows:
|
|
|
|
<code>
|
|
// Typedef for convenience.
|
|
typedef set<int, less<int> > intSet;
|
|
intSet s1, s2, s3;
|
|
// Add some elements to s1 and s2 ...
|
|
// Then form their union.
|
|
set_union(s1.begin(), s1.end(),
|
|
s2.begin(), s2.end(),
|
|
insert_iterator<intSet>(s3,s3.begin()) );
|
|
</code>
|
|
|
|
Here is an example illustrating all these operations.
|
|
|
|
<code>
|
|
<set-theory.cpp>=
|
|
#include <iostream>
|
|
#include <set>
|
|
#include <algorithm>
|
|
#include <iterator>
|
|
#include "printset.h"
|
|
|
|
using namespace std;
|
|
|
|
int main()
|
|
{
|
|
typedef set<int, less<int> > intSet;
|
|
|
|
intSet s1, s2, s3, s4;
|
|
|
|
for (int i=0; i<10; i++)
|
|
{ s1.insert(i);
|
|
s2.insert(i+4);
|
|
}
|
|
for (int i=0; i<5; i++) s3.insert(i);
|
|
|
|
cout << "s1 = " << s1 << endl;
|
|
cout << "s2 = " << s2 << endl;
|
|
cout << "s3 = " << s3 << endl;
|
|
|
|
// Is s1 a subset of s2?
|
|
bool test = includes(s2.begin(),s2.end(),s1.begin(),s1.end());
|
|
cout << "s1 subset of s2 is " << (test ? true. : false.) << endl;
|
|
|
|
// Is s3 a subset of s1?
|
|
test = includes(s1.begin(),s1.end(),s3.begin(),s3.end());
|
|
cout << "s3 subset of s1 is " << (test ? true. : false.) << endl;
|
|
|
|
// Form the union of s1 and s2.
|
|
set_union(s1.begin(), s1.end(), s2.begin(), s2.end(),
|
|
insert_iterator<intSet>(s4,s4.begin()) );
|
|
cout << "s1 union s2 = " << s4 << endl;
|
|
|
|
// Erase s4 and form intersection of s1 and s2. (If we don't erase
|
|
// s4 then we will get the previous contents of s4 as well).
|
|
s4.erase(s4.begin(),s4.end());
|
|
set_intersection(s1.begin(), s1.end(), s2.begin(), s2.end(),
|
|
insert_iterator<intSet>(s4,s4.begin()) );
|
|
cout << "s1 intersection s2 = " << s4 << endl;
|
|
|
|
// Now set difference.
|
|
s4.erase(s4.begin(),s4.end());
|
|
set_difference(s1.begin(), s1.end(), s2.begin(), s2.end(),
|
|
insert_iterator<intSet>(s4,s4.begin()) );
|
|
cout << "s1 minus s2 = " << s4 << endl;
|
|
|
|
// Set difference is not symmetric.
|
|
s4.erase(s4.begin(),s4.end());
|
|
set_difference(s2.begin(), s2.end(), s1.begin(), s1.end(),
|
|
insert_iterator<intSet>(s4,s4.begin()) );
|
|
cout << "s2 minus s1 = " << s4 << endl;
|
|
|
|
// Finally symmetric difference.
|
|
s4.erase(s4.begin(),s4.end());
|
|
set_symmetric_difference(s1.begin(), s1.end(), s2.begin(), s2.end(),
|
|
insert_iterator<intSet>(s4,s4.begin()) );
|
|
cout << "s1 symmetric_difference s2 = " << s4 << endl;
|
|
|
|
// Which is symmetric!
|
|
s4.erase(s4.begin(),s4.end());
|
|
set_symmetric_difference(s2.begin(), s2.end(), s1.begin(), s1.end(),
|
|
insert_iterator<intSet>(s4,s4.begin()) );
|
|
cout << "s2 symmetric_difference s1 = " << s4 << endl;
|
|
}
|
|
</code>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Maps
|
|
<p>
|
|
See the section <ref id="stlref" name="STL References">
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> STL Algorithms
|
|
<p>
|
|
See the section <ref id="stlref" name="STL References">
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> Threads in C++
|
|
-->
|
|
<sect> Threads in C++
|
|
<p>
|
|
<itemize>
|
|
<item> IBM pthread User Guide, Thread concepts, API reference
|
|
<url url="http://www.as400.ibm.com/developer/threads/uguide/document.htm">
|
|
and mirror site is at
|
|
<url name="IBM main site" url="http://java.icmc.sc.usp.br/library/books/ibm_pthreads/document.htm">
|
|
<p>
|
|
<item> QpThread Library for C++ provides object oriented framework in C++
|
|
for threads and Unix signals on top of system level threads (currently POSIX Threads)
|
|
<url url="http://lin.fsid.cvut.cz/~kra/index.html">
|
|
<p>
|
|
<item> ThreadJack supports Java-like multi-thread programming
|
|
model with platform independent C++ class library
|
|
<url url="http://www.esm.co.jp/divisions/open-sys/ThreadJack/index-e.html">
|
|
and here is the
|
|
<url name="download-site" url="http://www.esm.co.jp/divisions/open-sys/ThreadJack/source-dl-e.html">
|
|
<p>
|
|
<item> APE is the "APE Portable Environment" and class libraries for
|
|
writing portable threaded servers in C++, under UNIX (pthread) and Win32 API's.
|
|
APE provides portable class abstraction for threads, sockets, file handling, and
|
|
synchronization objects. The goal of APE is to make writing threaded
|
|
servers in C++ both practical and convient, even for small
|
|
and simple projects, and hence simplicity and low runtime overhead
|
|
are design goals <url url="http://www.voxilla.org/projects/projape.html">
|
|
<p>
|
|
<item> Portabale Thread Lib <url url="http://www.media.osaka-cu.ac.jp/~k-abe/PTL">
|
|
<p>
|
|
<item> Thread-Recyling in C++ <url url="http://www.sigs.de/html/kuhlmann.html">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Threads Tutorial
|
|
<p>
|
|
<itemize>
|
|
<item>You can download all the tutorials in one file from
|
|
<url url="http://www.aldev.8m.com"> and click on
|
|
"Source code C++
|
|
Programming howto" (<url name="aldev-site" url="http://www.aldev.8m.com/cppsrc.html">)
|
|
<p>
|
|
<item>Threads tutorial is at <url url="http://www.math.arizona.edu/swig/pthreads/threads.html">
|
|
<p>
|
|
<item>HERT tutorial at <url url="http://www.hert.org/docs/tutorials">, go here to
|
|
search for "Threads".
|
|
<p>
|
|
<item>Intro to threads at <url name="linuxjournal" url="http://www2.linuxjournal.com/lj-issues/issue61/3138.html">
|
|
<p>
|
|
<item>North Arizona Univ <url name="NAU" url="http://www.cse.nau.edu/~mc8/Thread/Contents.html">
|
|
<p>
|
|
<item>POSIX threads <url name="Acctcom multi-thread" url="http://users.actcom.co.il/~choo/lupg/tutorials/multi-thread/multi-thread.html">
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Designing a Thread Class in C++
|
|
<p>
|
|
This section is written by
|
|
<htmlurl url="mailto:ryte@geocities.com"
|
|
name="Ryan Teixeira">
|
|
and the document is located
|
|
<url name="here" url="http://www.geocities.com/SiliconValley/Heights/6038/dthreads.html">
|
|
.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Introduction
|
|
<p>
|
|
Multi threaded programming is becoming ever more popular. This section
|
|
presents a design for a C++ class that will encapsulate the threading
|
|
mechanism. Certain aspects of thread programming, like mutexes and semaphores
|
|
are not discussed here. Also, operating system calls to manipulate threads are
|
|
shown in a generic form.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Brief Introduction To Threads
|
|
<p>
|
|
To understand threads one must think of several
|
|
programs running at once. Imagine further
|
|
that all these programs have access to the same set of
|
|
global variables and function calls.
|
|
Each of these programs would represent a thread of
|
|
execution and is thus called a thread.
|
|
The important differentiation is that each thread does not have to wait
|
|
for any other thread to proceed. All the threads proceed
|
|
simultaneously. To use a metaphor, they are like runners
|
|
in a race, no runner waits for another runner. They
|
|
all proceed at their own rate.
|
|
|
|
Why use threads you might ask. Well threads can often
|
|
improve the performance of an application and they do not incur
|
|
significant overhead to implement. They effectively give
|
|
good bang for a buck. Imagine an image server program
|
|
that must service requests for images.
|
|
The program gets a request for an image from another program. It must
|
|
then retrieve the image from a database and send it to the program that
|
|
requested it. If the server were implemented in a single threaded
|
|
approach, only one program could request at a time. When it was busy
|
|
retrieving an image and sending it to a requestor, it could not
|
|
service other requests. Of course one could still implement such a system without
|
|
using threads. It would be a challenge though. Using threads, one can very
|
|
naturally design a system to handle multiple requests. A simple approach
|
|
would be to create a thread for each request received. The main
|
|
thread would create this thread upon receipt of a request. The thread
|
|
would then be responsible for the conversation with the client
|
|
program from that point on. After retrieving the image, the thread would
|
|
terminate itself. This would provide a smooth system
|
|
that would continue to service requests even though it
|
|
was busy serviceing other requests at the same time.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Basic Approach
|
|
<p>
|
|
The create a thread, you must specify a function that will become the entry
|
|
point for the thread. At the operating system level, this is a
|
|
normal function. We have to do a few tricks to wrap a C++ class around it
|
|
because the entry function cannot be a normal member function
|
|
of a class. However, it can be a static member function of a class. This is
|
|
what we will use as the entry point. There is a gotcha here though.
|
|
Static member functions do not have access to the this pointer of
|
|
a C++ object. They can only access static data. Fortunately,
|
|
there is way to do it. Thread entry point functions take a void *
|
|
as a parameter so that the caller can typecast any data and pass in to
|
|
the thread. We will use this to pass this to the static function. The static
|
|
function will then typecast the void * and use it to call a non
|
|
static member function.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> The Implementation
|
|
<p>
|
|
It should be mentioned that we are going to discuss a thread class with
|
|
limited functionality. It is possible to do more with threads
|
|
than this class will allow.
|
|
|
|
<code>
|
|
class Thread
|
|
{
|
|
public:
|
|
Thread();
|
|
int Start(void * arg);
|
|
protected:
|
|
int Run(void * arg);
|
|
static void * EntryPoint(void*);
|
|
virtual void Setup();
|
|
virtual void Execute(void*);
|
|
void * Arg() const {return Arg_;}
|
|
void Arg(void* a){Arg_ = a;}
|
|
private:
|
|
THREADID ThreadId_;
|
|
void * Arg_;
|
|
|
|
};
|
|
|
|
Thread::Thread() {}
|
|
|
|
int Thread::Start(void * arg)
|
|
{
|
|
Arg(arg); // store user data
|
|
int code = thread_create(Thread::EntryPoint, this, & ThreadId_);
|
|
return code;
|
|
}
|
|
|
|
int Thread::Run(void * arg)
|
|
{
|
|
Setup();
|
|
Execute( arg );
|
|
}
|
|
|
|
/*static */
|
|
void * Thread::EntryPoint(void * pthis)
|
|
{
|
|
Thread * pt = (Thread*)pthis;
|
|
pthis->Run( Arg() );
|
|
}
|
|
|
|
virtual void Thread::Setup()
|
|
{
|
|
// Do any setup here
|
|
}
|
|
|
|
virtual void Thread::Execute(void* arg)
|
|
{
|
|
// Your code goes here
|
|
}
|
|
</code>
|
|
|
|
It is important to understand that we are wrapping a C++ object
|
|
around a thread. Each object will provide an interface to a single thread. The
|
|
thread and the object are not the same.
|
|
The object can exist without a thread. In this implementation, the
|
|
thread does not actually exist until the Start function is called.
|
|
|
|
Notice that we store the user argument in the class.
|
|
This is necessary because we need a place to store it temporarily until the thread is
|
|
started. The operating system thread call allows us to pass an argument but we have used it to
|
|
pass the this pointer. So we store the real user argument in the class itself and when the
|
|
execute function is called it can get access to the argument.
|
|
|
|
<bf>Thread(); </bf>
|
|
This is the constructor.
|
|
|
|
<bf>int Start(void * arg); </bf>
|
|
This function provides the means to create the thread
|
|
and start it going. The argument arg provides a way for user data to be passed into the
|
|
thread. Start() creates the thread by calling the operating system thread creation function.
|
|
|
|
<bf>int Run(void * arg); </bf>
|
|
This is a protected function that should never be
|
|
tampered with.
|
|
|
|
<bf>static void * EntryPoint(void * pthis); </bf>
|
|
This function serves as the entry point to the thread.
|
|
It simply casts pthis to Thread * and
|
|
|
|
<bf>virtual void Setup(); </bf>
|
|
This function is called after the thread has been
|
|
created but before Execute() is called. If you override this function, remember to call the
|
|
parent class Execute().
|
|
|
|
<bf>virtual void Execute(void *); </bf>
|
|
You must override this function to provide your own
|
|
functionality.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Using The Thread Class
|
|
<p>
|
|
To use the thread class, you derive a new class. you
|
|
override the Execute() function where you provide your own functionality. You may override
|
|
the Setup() function to do any start up
|
|
duties before Execute is called. If you override
|
|
Setup(), remember to call the parent class Setup().
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect2> Conclusion
|
|
<p>
|
|
This section presented an implementation of a thread class written in C++.
|
|
Of course it is a simple approach but it provides a sound foundation
|
|
upon which to build a more robust design.
|
|
|
|
If you have comments or suggestions, email to
|
|
<htmlurl url="mailto:ryte@geocities.com"
|
|
name="Ryan Teixeira">
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt change> C++ Utilities
|
|
-->
|
|
<sect> C++ Utilities
|
|
<p>
|
|
Visit the following sites for C++ Utilities
|
|
<itemize>
|
|
<item> C++ Binary File I/O
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/cpp_BinaryFileIO.html">
|
|
<p>
|
|
<item> Portability Guide
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/cpp_PortabilityGuide.html">
|
|
<p>
|
|
<item> Snippets collections of C++ routines
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/cpp_Snippets.html">
|
|
and at <url url="http://www.strangecreations.com/library/snippets" name="snippets site">
|
|
<p>
|
|
<item> escape ISB for C++ - Provides information on how to
|
|
develop and program distributed, object-based applications in C++ for
|
|
Windows and Unix using the Netscape Internet Service Broker
|
|
<url url="http://docs.iplanet.com/docs/manuals/enterprise/cpluspg/contents.htm">
|
|
<p>
|
|
<item> Common C++ <url url="http://www.voxilla.org/projects/projape.html">
|
|
<p>
|
|
<item> Large List of free C++ libs
|
|
<url url="http://www.thefreecountry.com/developercity/freelib.html">
|
|
<p>
|
|
<item> C++ Tools <url url="http://development.freeservers.com">
|
|
<p>
|
|
<item> C++ Tools CUJ <url url="http://www.cuj.com/code">
|
|
<p>
|
|
<item> C++libs Univ of vaasa <url url="http://garbo.uwasa.fi/pc/c-lang.html">
|
|
</itemize>
|
|
|
|
<sect1> Memory Tools
|
|
<p>
|
|
Use the following memory debugging tools
|
|
<itemize>
|
|
<item> The <bf>"MPatrol"</bf> is a very powerful memory debugging tool.
|
|
It is at <url url="http://www.cbmamiga.demon.co.uk/mpatrol">
|
|
and at <url url="http://www.rpmfind.net"> go here and search mpatrol.
|
|
If you are using Linux then you must download the mpatrol*.src.rpm file from the
|
|
rpmfind.net. To update the mpatrol*.src.rpm to latest version, you can use the
|
|
old mpatrol.spec file and latest mpatrol*.tar.gz file to rebuild new *.src.rpm.
|
|
<p>
|
|
<item> On Linux contrib cdrom see mem_test*.rpm package
|
|
and at <url url="http://www.rpmfind.net"> go here and search mem_test.
|
|
<p>
|
|
<item> On Linux cdrom see ElectricFence*.rpm package
|
|
and at <url url="http://www.rpmfind.net"> go here and search electricfence.
|
|
<p>
|
|
<item> Purify Tool from Rational Software Corp <url url="http://www.rational.com">
|
|
<p>
|
|
<item> Insure++ Tool from Parasoft Corp <url url="http://www.parasoft.com">
|
|
<p>
|
|
<item> Linux Tools at <url url="http://www.xnet.com/~blatura/linapp6.html#tools">
|
|
<p>
|
|
<item> Search the Internet engines like Google, Yahoo, Lycos, Excite, Mamma.com
|
|
for keyword "Linux memory debugging tools".
|
|
<p>
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt change> Other Formats of this Document
|
|
-->
|
|
<sect> Other Formats of this Document
|
|
<p>
|
|
This document is published in 14 different formats namely - DVI, Postscript,
|
|
Latex, Adobe Acrobat PDF,
|
|
LyX, GNU-info, HTML, RTF(Rich Text Format), Plain-text, Unix man pages, single
|
|
HTML file, SGML (linuxdoc format), SGML (Docbook format), MS WinHelp format.
|
|
|
|
This howto document is located at -
|
|
<itemize>
|
|
<item> <url url="http://www.linuxdoc.org"> and click on HOWTOs and search
|
|
for howto document name using CTRL+f or ALT+f within the web-browser.
|
|
</itemize>
|
|
|
|
You can also find this document at the following mirrors sites -
|
|
<itemize>
|
|
<item> <url url="http://www.caldera.com/LDP/HOWTO">
|
|
<item> <url url="http://www.linux.ucla.edu/LDP">
|
|
<item> <url url="http://www.cc.gatech.edu/linux/LDP">
|
|
<item> <url url="http://www.redhat.com/mirrors/LDP">
|
|
|
|
<item> Other mirror sites near you (network-address-wise) can be found at
|
|
<url url="http://www.linuxdoc.org/mirrors.html">
|
|
select a site and go to directory /LDP/HOWTO/xxxxx-HOWTO.html
|
|
</itemize>
|
|
|
|
|
|
<itemize>
|
|
<item>
|
|
You can get this HOWTO document as a single file tar ball in HTML, DVI,
|
|
Postscript or SGML formats from -
|
|
<url url="ftp://www.linuxdoc.org/pub/linux/docs/HOWTO/other-formats/">
|
|
and <url url="http://www.linuxdoc.org/docs.html#howto">
|
|
<p>
|
|
<item>Plain text format is in: <url url="ftp://www.linuxdoc.org/pub/linux/docs/HOWTO">
|
|
and <url url="http://www.linuxdoc.org/docs.html#howto">
|
|
<p>
|
|
<item>Single HTML file format is in:
|
|
<url url="http://www.linuxdoc.org/docs.html#howto">
|
|
<p> Single HTML file can be created with command (see man sgml2html) -
|
|
sgml2html -split 0 xxxxhowto.sgml
|
|
<p>
|
|
<item>Translations to other languages like French, German, Spanish,
|
|
Chinese, Japanese are in
|
|
<url url="ftp://www.linuxdoc.org/pub/linux/docs/HOWTO">
|
|
and <url url="http://www.linuxdoc.org/docs.html#howto">
|
|
Any help from you to translate to other languages is welcome.
|
|
</itemize>
|
|
The document is written using a tool called "SGML-Tools" which can be got from -
|
|
<url url="http://www.sgmltools.org">
|
|
Compiling the source you will get the following commands like
|
|
<itemize>
|
|
<item>sgml2html xxxxhowto.sgml (to generate html file)
|
|
<item>sgml2html -split 0 xxxxhowto.sgml (to generate a single page html file)
|
|
<item>sgml2rtf xxxxhowto.sgml (to generate RTF file)
|
|
<item>sgml2latex xxxxhowto.sgml (to generate latex file)
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Acrobat PDF format <label id="acrobatpdf">
|
|
<p>
|
|
PDF file can be generated from postscript file using
|
|
either acrobat <bf>distill</bf> or <bf>Ghostscript</bf>.
|
|
And postscript file is generated
|
|
from DVI which in turn is generated from LaTex file.
|
|
You can download distill software from <url url="http://www.adobe.com">. Given below
|
|
is a sample session:
|
|
<code>
|
|
bash$ man sgml2latex
|
|
bash$ sgml2latex filename.sgml
|
|
bash$ man dvips
|
|
bash$ dvips -o filename.ps filename.dvi
|
|
bash$ distill filename.ps
|
|
bash$ man ghostscript
|
|
bash$ man ps2pdf
|
|
bash$ ps2pdf input.ps output.pdf
|
|
bash$ acroread output.pdf &
|
|
</code>
|
|
Or you can use Ghostscript command <bf>ps2pdf</bf>.
|
|
ps2pdf is a work-alike for nearly all the functionality of
|
|
Adobe's Acrobat Distiller product: it
|
|
converts PostScript files to Portable Document Format (PDF) files.
|
|
<bf>ps2pdf</bf> is implemented as a very small command script
|
|
(batch file) that invokes Ghostscript, selecting a special "output device"
|
|
called <bf>pdfwrite</bf>. In order to use ps2pdf, the pdfwrite
|
|
device must be included in the makefile when Ghostscript was compiled;
|
|
see the documentation on building Ghostscript for details.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Convert linuxdoc to Docbook format <label id="linuxdoc2docbook">
|
|
<p>
|
|
This document is written in linuxdoc SGML format. The Docbook SGML format
|
|
supercedes the linuxdoc format and has lot more features than linuxdoc.
|
|
The linuxdoc is very simple and is easy to use. To convert linuxdoc SGML
|
|
file to Docbook SGML use the program <bf>ld2db.sh</bf> and some perl scripts.
|
|
The ld2db output is not 100% clean and you need to use the <bf>clean_ld2db.pl</bf>
|
|
perl script. You may need to manually correct few lines in the document.
|
|
<itemize>
|
|
<item> Download ld2db program from <url url="http://www.dcs.gla.ac.uk/~rrt/docbook.html">
|
|
or from <url name="Al Dev site" url="http://www.aldev.8m.com/cppsrc.html">
|
|
<item> Download the cleanup_ld2db.pl perl script from
|
|
from <url name="Al Dev site" url="http://www.aldev.8m.com/cppsrc.html">
|
|
</itemize>
|
|
The ld2db.sh is not 100% clean, you will get lots of errors when you run
|
|
<code>
|
|
bash$ ld2db.sh file-linuxdoc.sgml db.sgml
|
|
bash$ cleanup.pl db.sgml > db_clean.sgml
|
|
bash$ gvim db_clean.sgml
|
|
bash$ docbook2html db.sgml
|
|
</code>
|
|
And you may have to manually edit some of the minor errors after
|
|
running the perl script. For e.g. you may need to put closing tag <
|
|
/Para> for each <
|
|
Listitem>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Convert to MS WinHelp format <label id="mswinhelp">
|
|
<p>
|
|
You can convert the SGML howto document to Microsoft Windows Help file,
|
|
first convert the sgml to html using:
|
|
<code>
|
|
bash$ sgml2html xxxxhowto.sgml (to generate html file)
|
|
bash$ sgml2html -split 0 xxxxhowto.sgml (to generate a single page html file)
|
|
</code>
|
|
Then use the tool <url name="HtmlToHlp" url="http://Javadocs.planetmirror.com/htmltohlpe.html">.
|
|
You can also use sgml2rtf and then use the RTF files for generating winhelp files.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
-->
|
|
<sect1> Reading various formats <label id="readformats">
|
|
<p>
|
|
In order to view the document in dvi format, use the xdvi program. The xdvi
|
|
program is located in tetex-xdvi*.rpm package in Redhat Linux which can be
|
|
located through ControlPanel | Applications | Publishing | TeX menu buttons.
|
|
To read dvi document give the command -
|
|
<tscreen><verb>
|
|
xdvi -geometry 80x90 howto.dvi
|
|
man xdvi
|
|
</verb></tscreen>
|
|
And resize the window with mouse.
|
|
To navigate use Arrow keys, Page Up, Page Down keys, also
|
|
you can use 'f', 'd', 'u', 'c', 'l', 'r', 'p', 'n' letter
|
|
keys to move up, down, center, next page, previous page etc.
|
|
To turn off expert menu press 'x'.
|
|
|
|
You can read postscript file using the program 'gv' (ghostview) or
|
|
'ghostscript'.
|
|
The ghostscript program is in ghostscript*.rpm package and gv
|
|
program is in gv*.rpm package in Redhat Linux
|
|
which can be located through ControlPanel | Applications | Graphics menu
|
|
buttons. The gv program is much more user friendly than ghostscript.
|
|
Also ghostscript and gv are available on other platforms like OS/2,
|
|
Windows 95 and NT, you view this document even on those platforms.
|
|
|
|
<itemize>
|
|
<item>Get ghostscript for Windows 95, OS/2, and for
|
|
all OSes from <url url="http://www.cs.wisc.edu/~ghost">
|
|
</itemize>
|
|
|
|
To read postscript document give the command -
|
|
<tscreen><verb>
|
|
gv howto.ps
|
|
ghostscript howto.ps
|
|
</verb></tscreen>
|
|
|
|
You can read HTML format document using Netscape Navigator, Microsoft Internet
|
|
explorer, Redhat Baron Web browser or any of the 10 other web browsers.
|
|
|
|
You can read the latex, LyX output using LyX a X-Windows front end to latex.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> Translations To Other Languages
|
|
-->
|
|
<sect> Translations To Other Languages
|
|
<p>
|
|
<itemize>
|
|
<item> Translation to Polish is at <url url="http://strony.wp.pl/wp/chq/c/howto/book1.htm">
|
|
thanks to Darek Ostolski
|
|
<htmlurl url="mailto:chq@wp.pl"
|
|
name="Darek Ostolski">
|
|
<item>Translations to other languages like French, German, Spanish,
|
|
Chinese, Japanese are in
|
|
<url url="ftp://www.linuxdoc.org/pub/linux/docs/HOWTO">
|
|
and <url url="http://www.linuxdoc.org/docs.html#howto">
|
|
</itemize>
|
|
Any help from you to translate to other languages is welcome.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> Copyright
|
|
-->
|
|
<sect> Copyright
|
|
<p>
|
|
Copyright policy is GNU/GPL as per LDP (Linux Documentation project).
|
|
LDP is a GNU/GPL project.
|
|
Additional requests are that you retain the author's name, email address
|
|
and this copyright notice on all the copies. If you make any changes
|
|
or additions to this document then you please
|
|
intimate all the authors of this document.
|
|
Brand names mentioned in this document are property of their respective
|
|
owners.
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
<chapt> Appendix A String Program Files <label id="Appendix A">
|
|
-->
|
|
<sect> Appendix A String Program Files <label id="Appendix A">
|
|
<p>
|
|
|
|
You can <bf>download all programs as a single tar.gz</bf> file from
|
|
<ref id="Download String">
|
|
and give the following command to unpack
|
|
<code>
|
|
bash$ man tar
|
|
bash$ tar ztvf C++Programming-HOWTO.tar.gz
|
|
This will list the table of contents
|
|
|
|
bash$ tar zxvf C++Programming-HOWTO.tar.gz
|
|
This will extract the files
|
|
</code>
|
|
|
|
<itemize>
|
|
<item> Read the header file first and then see the example cpp program
|
|
<itemize>
|
|
<item> String.h
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/String.h">
|
|
<item> StringBuffer.h
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/StringBuffer.h">
|
|
<item> StringTokenizer.h
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/StringTokenizer.h">
|
|
<item> StringRW.h
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/StringRW.h">
|
|
<item> string_multi.h
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/string_multi.h">
|
|
<item> example_String.cpp
|
|
<url name="example_String.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
</itemize>
|
|
<p>
|
|
|
|
<item> File manipulation class, only length() function is implemented..
|
|
<itemize>
|
|
<item> File.h
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/File.h">
|
|
<item> File.cpp
|
|
<url name="File.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
</itemize>
|
|
<p>
|
|
|
|
<item> The zap() implemented here ..
|
|
<itemize>
|
|
<item> my_malloc.h
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/my_malloc.h">
|
|
<item> my_malloc.cpp
|
|
<url name="my_malloc.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
</itemize>
|
|
<p>
|
|
|
|
<item> Implementation of String class...
|
|
<itemize>
|
|
<item> String.cpp
|
|
<url name="String.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
<item> StringTokenizer.cpp
|
|
<url name="StringTokenizer.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
<item> StringBuffer.cpp
|
|
<url name="StringBuffer.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
<item> StringRW.cpp
|
|
<url name="StringRW.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
</itemize>
|
|
<p>
|
|
|
|
<item> Debug facilities ..
|
|
<itemize>
|
|
<item> debug.h
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/debug.h">
|
|
<item> debug.cpp
|
|
<url name="debug.cpp" url="http://www.aldev.8m.com/cppsrc.html">
|
|
<item> Makefile.unx
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/Makefile.unx">
|
|
</itemize>
|
|
|
|
<p>
|
|
<item> Sample Java file for testing the functionalities of String class ..
|
|
<itemize>
|
|
<item> string.java
|
|
<url url="http://www.angelfire.com/country/aldev0/cpphowto/string.java">
|
|
</itemize>
|
|
|
|
</itemize>
|
|
<!--
|
|
*******************************************
|
|
************ End of Section ***************
|
|
*******************************************
|
|
|
|
|
|
|
|
|
|
-->
|
|
</article>
|