You are viewing a plain text version of this content. The canonical link for it is here.
Posted to java-dev@axis.apache.org by ha...@apache.org on 2004/09/13 12:31:12 UTC
cvs commit: ws-axis/c/docs antbuild-guide.html
hawkeye 2004/09/13 03:31:12
Added: c/docs antbuild-guide.html
Log:
Axis C++ ANT Build Guide
Submitted by: Adrian Dick
Revision Changes Path
1.1 ws-axis/c/docs/antbuild-guide.html
Index: antbuild-guide.html
===================================================================
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<HTML>
<HEAD>
<TITLE> ANT Build Guide </TITLE>
<META NAME="Author" CONTENT="Adrian Dick">
<META NAME="Keywords" CONTENT="">
<META NAME="Description" CONTENT="">
</HEAD>
<BODY>
<h1>Axis C++ ANT Build Guide</h1>
<P>
This document provides instructions for using and extending the ANT based build for the AXIS C++ project.</P>
<P><A href="#prepareSystem">Preparing system</A><BR>
<A href="#thirdPartySoftware">Getting necessary third party software</A><BR>
<A href="#cvsExtract">Getting a CVS checkout</A><BR>
<A href="#propertyFiles">Property Files</A><BR>
<A href="#runningTheBuild">Running the ANT build </A><BR>
<A href="#addingExtraPlatform">Adding an extra platform </A></P>
<H2><A name="prepareSystem"></A>Preparing system</H2>
<P>
To use the ANT based build you will need to install the following:<UL>
<LI>Apache ANT<UL>
<LI>Available from <A href="http://ant.apache.org">http://ant.apache.org</A></LI>
<LI>These scripts have been developed and tested using version 1.6.x</LI>
</UL>
</LI>
<LI>Java SDK - required for running of ANT scripts, and the compilation of WSDL2Ws tool
<UL>
<LI>Require version 1.4+</LI>
</UL>
</LI>
<LI>Ant-Contrib - provide numerous extensions to ANT, including the
compilation of C/C++.
<UL>
<LI>Available from <A href="http://ant-contrib.sourceforge.net">http://ant-contrib.sourceforge.net</A></LI>
<LI>Place JARs into <CODE>[ANT INSTALL DIR]/lib</CODE>.</LI>
<LI>Require both ant-contrib and cpptasks</LI>
</UL>
</LI>
<LI>Doxygen - Used for generating API documentation
<UL>
<LI>Available from <A href="http://www.doxygen.org">http://www.doxygen.org</A></LI>
</UL>
</LI>
<LI>Compiler / Linker
<UL>
<LI>For Windows - Microsoft Visual C++ v6</LI>
<LI>For Linux - gcc / g++</LI>
<LI>For AIX - IBM Visual Age for C++</LI>
</UL>
</LI>
</UL>
<P>
Before running ANT the following environment variables need to be set:</P>
<UL>
<LI><CODE>ANT_HOME</CODE> - location of ant installation</LI>
<LI><CODE>JAVA_HOME</CODE> - location of java installation</LI>
<LI><CODE>PATH</CODE> - to include <CODE>[ANT_HOME]/bin</CODE> and <CODE>[JAVA_HOME]/bin</CODE>.
<UL>
<LI>Also ensure doxygen and compilers are available on the system path.</LI>
</UL>
</LI>
</UL>
<H2><A name="thirdPartySoftware"></A>Getting necessary third party
software</H2>
<P>Axis Cpp Developers can use either Xerces-c or the Expat XML Parsers
to build the Axis Cpp.</P>
<P><B>Expat XML Parser</B></P>
<P>You can get expat binaries from <A
href="http://sourceforge.net/projects/expat/">http://sourceforge.net/projects/expat/</A>.</P>
<P><B>Xerces-C XML Parser</B></P>
<P>You can get Xerces-C binaries from <A href="http://xerces.apache.org">http://xerces.apache.org</A>.</P>
<H2><A name="cvsExtract"></A>Getting a cvs checkout</H2>
<P>Visit <A href="windows/cpp/">http://ws.apache.org/</A> Click on
�axis� and then on �CVS Repository� to find details on how to access the
CVS Repository. <BR>In short summary:<BR>
Anyone can checkout the source code from our anonymous CVS server. To
do so, simply use the following commands (if you are using a GUI CVS
client, configure it appropriately): </P>
<BLOCKQUOTE><CODE>cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic
login<BR>
password: anoncvs<BR>
<BR>
cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout ws-axis</CODE></BLOCKQUOTE>
<P>The checkout of the repository will be created in the current directory
in a folder named �<CODE>ws-axis</CODE>�<BR>
<BR>
The checked out folder ws-axis will be referred to as <CODE>[CHECKOUT_HOME]</CODE>
from this point on.</P>
<H2><A name="propertyFiles"></A>Property Files</H2>
<P>To aid in the portability of the ANT scripts, a number of property files are used. The script will decide which to use based on the platform in which it is currently running. The property files are found in <CODE>ws-axis/c</CODE> with the following naming convention:</P>
<BLOCKQUOTE><CODE>build.<I>[platform]</I>.properties</CODE></BLOCKQUOTE>
<P>A number of example property files are provided for Windows, Linux, AIX and Solaris, tt is intended that you update these files to suit your development and buid environment. This includes location of third party software dependencies and target packaging structure.</P>
<H2><A name="runningTheBuild"></A>Running the ANT build</H2>
<P>Having carried out the instructions above, the running of the ant build is simply a matter of typing the following at a command prompt:</P>
<BLOCKQUOTE><CODE>ant</CODE></BLOCKQUOTE>
<P>This will carry out the following:</P>
<UL>
<LI>Build Axis C Client library</LI>
<LI>Build Axis C Transport library</LI>
<LI>Build Axis C XML Parser library
<UL>
<LI>Expat, Xerces-C, etc configurable through the property files</LI>
</UL>
</LI>
<LI>Build and package WSDL2Ws tool</LI>
<LI>Generate API Documentation</LI>
<LI>Package artefacts into a distributable structure
<UL>
<LI>This structure is configurable through the property files</LI>
</UL>
</LI>
<LI>Validate all artefacts have been correctly generated</LI>
</UL>
<P>To remove artefacts from a previous build use the following command: </P>
<BLOCKQUOTE><CODE>ant clean</CODE></BLOCKQUOTE>
<H2><A name="addingExtraPlatform"></A>Adding an extra platform</H2>
<P>The AXIS community would greatly appreciate your input, if you're working on a platform not currently supported by the ANT scripts.<BR>Below, are the steps required to add an additional platform;</P>
<OL>
<LI>Add platform detection to <CODE>pre-init</CODE> target, eg:<PRE><condition property="linux">
<os name="Linux"/>
</condition></PRE></LI>
<LI>Update platform property within <CODE>initialize</CODE> target, eg: <PRE><condition property="platform" value="Linux">
<isset property="linux"/>
</condition></PRE></LI>
<LI>Provide an additional property file in <CODE>ws-axis/c</CODE> to match your platform. This uses the naming convention <CODE>build.[<I>platform</I>].properties</CODE>, where platform is as specified in step 2.</LI>
<LI>Provide <CODE>compiler</CODE> definition for platform, include a condition check for the correct platform, eg: <PRE><compiler id="Linuxgcc" name="g++" if="linux">
<compilerarg value="-Wall"/>
<compilerarg value="-Wshadow"/>
<compilerarg value="-g"/>
<compilerarg value="-O2"/>
<defineset>
<define name="ENABLE_AXIS_EXCEPTION"/>
<define name="HAVE_CONFIG_H"/>
<define name="PIC"/>
</defineset>
<includepath path="${dir.include}"/>
</compiler></PRE> Note: Compilers may extend one another, which can be useful if an additional platform uses the same compiler, but maybe only small variations in the parameters.</LI>
<LI>Provide <CODE>linker</CODE> definition for platform, include a condition check for the correct platform, eg: <PRE><linker id="LinuxLinker" name="g++" libtool="true" if="linux">
<linkerarg value="-g"/>
<libset libs="stdc++"/>
</linker></PRE> Note: As for compilers, linkers may extend one another.</LI>
<LI>Add new <CODE>compiler</CODE> and <CODE>linker</CODE> to the <CODE>cc</CODE> task within <CODE>compileAxisClient</CODE>, <CODE>compileAxisTransport</CODE> and <CODE>compileAxisXMLParser</CODE> targets, eg: <PRE><cc outfile="${dir.bin}/${transportLibraryName}" objdir="${dir.objects}"
exceptions="true" failonerror="false" outtype="shared" multithreaded="true">
<!-- Compilers -->
<compiler refid="Linuxgcc"/>
<compiler refid="AIXxlc"/>
<compiler extends="VisualC++">
<defineset>
<define name="AXISTRANSPORTDLL_EXPORTS"/>
</defineset>
</compiler>
<!-- Linkers -->
<linker refid="LinuxLinker"/>
<linker refid="AIXLinker"/>
<linker extends="VisualC++Linker">
<syslibset libs="wsock32"/>
</linker>
<!-- Files to compile -->
<fileset dir="${dir.src}">
<include name="transport/axis/*.cpp"/>
<!-- The following files need to be excluded -->
<exclude name="transport/axis/SecureChannel.cpp"/>
</fileset>
</cc></PRE></LI>
</OL>
</BODY>
</HTML>