Functions | |||
| char* | strcpy (char *dest, const char *src) NONBANKED | ||
| Copies the string pointed to be src (including the terminating `\0' character) to the array pointed to by dest. More... | |||
| int | strcmp (const char *s1, const char *s2) NONBANKED | ||
| Compares the two strings s1 and s2. More... | |||
| void* | memcpy (void *dest, const void *src, size_t len) NONBANKED | ||
| Copies n bytes from memory area src to memory area dest. More... | |||
| char* | reverse (char *s) | ||
| Reverses the characters in the string. More... | |||
| char* | strcat (char *s1, const char *s2) NONBANKED | ||
| int | strlen (const char *s) NONBANKED | ||
| Calculates the length of the string, not including the terminating `\0' character. | |||
| char* | strncat (char *s1, const char *s2, int n) NONBANKED | ||
| Concatenate s2 on the end of s1. More... | |||
| int | strncmp (const char *s1, const char *s2, int n) NONBANKED | ||
| Compare strings (at most n bytes): s1>s2: >0 s1==s2: 0 s1<s2: <0. | |||
| char* | strncpy (char *s1, const char *s2, int n) NONBANKED | ||
| Copy s2 to s1, truncating or null-padding to always copy n bytes. More... |
| char * strcpy (char * dest, const char * src) |
Copies the string pointed to be src (including the terminating `\0' character) to the array pointed to by dest.
The strings may not overlap, and the destination string dest must be large enough to receive the copy.
| dest | Array to copy into. |
| src | Array to copy from. |
| int strcmp (const char * s1, const char * s2) |
Compares the two strings s1 and s2.
It returns an integer less than, equal to, or greater than zero if s1 is found, respectively, to be less than, to match, or be greater than s2.
| void * memcpy (void * dest, const void * src, size_t len) |
Copies n bytes from memory area src to memory area dest.
The memory areas may not overlap.
| dest | Array to copy into. |
| src | Array to copy from. |
| len | The length in bytes of src. |
| char * reverse (char * s) |
Reverses the characters in the string.
For example 'abcdefg' will become 'gfedcba'. Banked as the string must be modifiable.
| char * strncat (char * s1, const char * s2, int n) |
Concatenate s2 on the end of s1.
s1 must be large enough. At most n characters are moved.
| char * strncpy (char * s1, const char * s2, int n) |
Copy s2 to s1, truncating or null-padding to always copy n bytes.
If there is no \0 in the first n bytes of s2 then s1 will not be null terminated.


| HOME | DOWNLOAD | DOCUMENTATION | FORUM | FAQ |
> Home > Documentation > Spherical Harmonic I/O and Storage
SHCILMTOCINDEX(1) SHTOOLS 2.6 SHCILMTOCINDEX(1)
SHCilmToCindex
SHCilmToCindex - Convert a three-dimensional array of complex spherical harmonic coefficients to a two-dimensional indexed array.
SYNOPSIS
SUBROUTINE SHCilmToCindex ( CILM, CINDEX, DEGMAX ) REAL*8 CILM(2, *, *), CINDEX(2, *) INTEGER, OPTIONAL DEGMAX
DESCRIPTION
SHCilmToCindex will convert a three-dimensional array of complex spherical harmonic coefficients to a two-dimensional indexed array. The degree L and order M corresponds to the index L*(L+1)/2+M+1. The default is to convert the entire array CILM, but a subset of this array can be converted by specifying the optional argument DEGMAX.
ARGUMENTS
CILM (input) REAL*8, DIMENSION (2, *, *) The input complex spherical harmonic coefficients. CILM(1, *, *) and CILM(2, *, *) correspond to the real and imaginary components, respectively. CINDEX (output) REAL*8, DIMENSION (2, *) The indexed output complex spherical harmonic coefficients. The second dimension of this array must be greater than (LMAX+1)*(LMAX+2)/2 where LMAX is the maximum degree of CILM. DEGMAX (input) INTEGER, OPTIONAL The maximum degree of the output coefficients. By default, the entire array CCILM will be converted.
SEE ALSO
shctor(1), shrtoc(1), shcindextocilm(1) <http://www.ipgp.jussieu.fr/~wieczor/SHTOOLS/SHTOOLS.html>
COPYRIGHT AND LICENSE
Copyright 2005, 2006 by Mark Wieczorek<EMAIL_ADDRESS>This is free software; you can distribute and modify it under the terms of the revised BSD license. SHTOOLS 2.6 2009-08-18 SHCILMTOCINDEX(1)
> Home > Documentation > Spherical Harmonic I/O
| Centre National de la Recherche Scientifique | Institut de Physique du Globe de Paris | © 2011 Mark Wieczorek |


We have {{invite.company.specialSignups()}} people signed up at {{invite.company.name}}. We’ll keep you informed on {{invite.company.name}}’s progress. When there are {{invite.company.maxSignups}}, we’ll enable it at your company.
Help us out by spreading the word.
Hi there, fellow coworker
You're invited to join the {{invite.company.name}} network on Slügg, an informal, on-demand, trusted carpooling network.


Revealed: Newcastle United's goal of the season so far as chosen by fans
Hunders of votes were cast by ChronicleLive readers - and we can now reveal Newcastle United's goal of the season so far
by Chris KnightNewcastle United have remarkably relied on defenders for most of their goals so far this campaign.
The Magpies have scored just 11 times in their opening 12 Premier League encounters, with centre-backs such as Ciaran Clark, Federico Fernandez, Jamaal Lascelles, and Fabian Schar all chipping in.
But despite United's struggles in the attacking third, Steve Bruce's side have already notched several memorable strikes for supporters to savour.
We decided to select four of these and put it to a vote during the international break to see which goal would be considered the fans' favourite so far.
The four contenders read as follows:
- Joelinton's first United goal against Tottenham
- Jetro Willems' thunderbolt at Liverpool
- Matty Longstaff's winner against Manchester United
- Jonjo Shelvey's free-kick at West Ham.
Hundreds of votes were cast by ChronicleLive readers, and two strikes stood out as clear favourites among supporters.
But - perhaps unsurprisingly - Matty Longstaff's memorable goal against the Red Devils in front of the Gallowgate came out on top for the best goal of the season so far.
The 19-year-old secured 45% of the vote - edging out Willems' surprise opener at Anfield which was backed by 42% of supporters.
Shelvey's screamer at the London Stadium - which ultimately proved to be the winner for the Magpies - rounded out the podium positions after being backed by 10% of fans.
Joelinton's winner at Tottenham following a 17-pass move was selected by just 4% of supporters.


SECA Evening Event: Venture capital for family offices, insurance firms and pension funds
by Association Suisse des Investisseurs en Capital et de Financement seca logo| 28 - 28 jan 2020 | Genève |
This event is aimed at managers and decision-makers from the investment sector of Swiss family offices, insurance firms and pension funds.
This event, which is organized by the Swiss Private Equity & Corporate Finance Association in cooperation with the venture capital companies btov Partners and VI Partners, is aimed at managers and decision-makers from the investment sector of Swiss family offices, insurance firms and pension funds.
Highly developed startup ecosystems such as Silicon Valley in the USA offer institutional investors exciting investment opportunities and have a very lasting influence on the competitiveness and economic strength of their region. Particularly important in this context are the regular investments of US pension funds in venture capital funds that focus on Silicon Valley. Swiss pension funds, on the other hand, have little involvement in venture capital in Europe. Family offices and insurance firms already make up a significant part of the investment volume in venture capital funds, however the potential could be much higher.
The aim of the event is to present the venture capital sector as an asset class to selected pension funds, insurance firms and family office decision-makers by examining the structure of this sector in its entirety, presenting venture capital approaches relevant to institutional investors and discussing them between participants and speakers.
Key questions of the event:
- What is the economic significance of the asset class venture capital as a driving force for innovation?
- What is the involvement of pension funds in the USA vs. Europe, what are the effects of this involvement and what are the returns?
- How does the business of a venture capital company work in practice?
- What concrete venture capital investment opportunities are there for pension funds and family offices in the Swiss context?
Speakers:
- Walter Reinl, Partner and Managing Director, BCG
- Diego Braguglia, Managing Partner, VI Partners AG
- Dr. Hauke Brede, Geschäftsführer, UP2INVEST GmbH
- Andreas Goeldi, Partner, btov Partners AG
- Christian Winkler, Partner, btov Partners AG
Event Adress
Geneva


This package contain classes providing various graphics service to render an image on a viewer for display and to plot a signal on a graph.


the way of the sword; training the mind, body, and character through one-one-one striking practice using the shinai while wearing bogu
kenshi
kendoist
dan
ranking system for advanced levels (1=lowest, 8=highest); equivalent to black belt in other martial arts
kyu
ranking system for beginning levels (6=lowest, 1=highest); equivalent to a brown belt in other martial arts
yudansha
kendoist with a rank of 1st dan (shodan) or higher
kodansha
one with a high dan rank, typically 5th dan (godan) or higher
sensei
instructor, usually with rank 4th dan (yondan) or higher
shomen
the side of the dojo or hall farthest from the main entrance, the side having the highest place of honor
seiza
seated attention position
kiai
a shout or yell to show spirit
kigurai
confidence, presence, bearing
kokyu
breathing
shinsa
promotional examination
counting (1,2,3, ... ,10)
ichi, ni, san, shi, go, roku, shichi, hachi, kyu, ju
B. Commands and Responses
hajime
"Begin!"
yame
"Stop!"
ki-o-tsuke
"Attention!"
seiretsu
"make a line"
chakuza
"sit down (in seiza)"
kiritsu
"stand up"
men-tsuke
"put on the men"
men-tore
"take off the men"
nuke-to
"draw the sword (shinai)"
osame-to
"return the sword (shinai)"
hai
"Yes!" Used in place of "okay", or "I understand."
II. Equipment
A. Uniform
hakama
kendo clothing worn on the lower part of the body, a long divided skirt-like trousers
keiko-gi
kendo clothing worn on the upper part of the body, a thick jacket-like shirt
B. Armor
bogu
kendo armor consisting of men, kote, do, and tare
men
kendo armor to protect the face, head, and shoulders
kote
kendo armor used to proect the hand and forearm
do
kendo armor to protect the trunk and chest
tare
kendo armor to protect the waist, groin, and upper legs
tsuki
flap on the men which protects the throat
tenugui
thin cotton towel worn on the head under the men
nafuda
name tag worn on the center of the tare; also called "zekken"
C. Swords
shinai
bamboo sword used in kendo
kensen
the tip of the shinai
nakayui
thin strip of leather tied around the shinai about one third down from the tip
tsuba
circular guard on the shinai
tsuka
the handle of the shinai
tsuka-gashira
the very end (bottom) of the tsuka
tsuru
the string which holds the shinai together
monouchi
the region of the shinai most effective for striking, located between the tip and the nakayui
datotsu-bu
the part of the shinai with which one should strike the opponent. Refers to the jin-bu (side opposite the tsuru) around the region of the mono-uchi.
bokken
wooden sword, primarily used for kendo kata
bokuto
same as bokken
III. Manners and Etiquette
A. Opening and Closing
mokuso
meditation performed in the seiza position
mokuso-yame
command to stop mokuso
rei
bow
shomen-ni-rei
command given to bow to the shomen; done while in seiza
sensei-ni-rei
command given to bow to the sensei, done while in seiza
onegai shimasu
"I request the favor (of a practice)"; said at the beginning of practice during "sensei-ni-rei"
arigato gozaimashita
"Thank you very much"; said at the end of practice during "sensei-ni-rei"
B. Always
rei-gi
matters of etiquette
rei-ho
doctrines of etiquette
chaku-so
the manner of wearing keikogi, hakama, and bogu
ritsu-rei
standing bow
sage-to
the posture taken when performing ritsu-rei, with the shinai held in the left hand with the arm hanging naturally at the side. The tsuru faces downward and the hand next to the tsuba.
sogo-no-rei
ritsu-rei to the opponent. The angle is about 15 degrees, and eye contact is maintained.
IV. Practice and Instruction
A. General
keiko
practice, training
ashi-sabaki
footwork
ato-geiko
literally after practice, usually a second practice session for advanced kenshi following a primary practice session which stresses kihon
datotsu
striking and thrusting. A valid point is referred to as yuko datotsu.
datotsu-bui
the correct striking or thrusting zones of the kendo-gu (protective gear), refers to the men, kote, do, and tsuki areas
datotsu-no-kikai
chance of strike
furi-kaburi
big movement swing of the shinai above one's head
hasuji
cutting path of the sword (angle of cut)
haya-suburi
fast suburi, one count per backward step plus foward strike
hiraki-ashi
footwork used when the body is moving diagonally (front foot is same side as forward shoulder)
issoku-itto-no-maai
distance from which one can strike in one step
jiyu-keiko
free practice
kakari-geiko
attack practice
kamae-te
command to assume kamae
kihon
basics
kihon-dosa
basic exercises, including uchi-kata and suburi
kiri-kaeshi
basic exercise in which the sides of the men are struck repeatedly, typically in sets of a straight men followed by 4 strikes forward and 5 strikes backward
ma-ai
distance between opponents
mawari-geiko
rotation keiko
men-no-uchi, gokai
"basic men strike, 5 times"
men-no-uchi, sankyodo
"basic men strike, three count movements" (1=raise shinai, 2=strike, moving forward, 3=step back)
metsuke
use of the eyes to see the opponent, see basic concepts
motodachi
person being struck to provide instruction, for example in uchikomi-geiko, kakari-geiko, or kihon shiai
okuri-ashi
the most basic footwork used in kendo, where the feet start and end in the basic kamae position with the right foot in front and the toes of the left foot even with the line of the right heel
sayu-men
the right and left striking zones of the men
seme
pressure applied to one's opponent
shiai-geiko
match practice
shin-kokyu
deep breathing exercise
shisei
posture
shizentai
natural standing position
shomen-uchi
a strike to the center of the men
suri-ashi
footwork in which the feet do not lose contact with the floor
te-no-uchi
the usage of the hands to tighten/loosen the grip on the shinai or adjusting the balance between the hands when striking or responding
uchikomi-geiko
practice striking the basic points on the motodachi
waza
technique, see advanced concepts
zanshin
mental and physical presence of spirit, especially after completing an attack
B. Positions
kamae
basic stance; ready position
chudan-no-kamae
basic kamae, with the kensen pointed at the opponent's throat
judan-no-kamae
kamae with the shinai above the head, with the left hand above the forehead about one fist away
tai-to
holding the shinai at the left hip, ready to draw. The tsuka-gashira should be in front of the center of the body.
sonkyo
the crouching position in which begins and ends each bout
tsuba-zeriai
the position in which the opponents are close to each other with tsuba or fists together
C. Types of Practice
suburi
sword swinging techniques
jogeburi
full sword swing; an exercise used for relaxing and warming up the shoulders and upper back
suburi
basic exercise which simulates striking the men repeatedly, performed without an opponent
suburi-ikkyodo
one-count suburi (alternate striking forward and backward on each count)
suburi-nikyodo
two-count suburi (raise the shinai on the odd count; strike on the even count, alternating the going forward and backward and each strike)
V. Tournaments and Matches
A. General
shiai
match
shiai-jo
court
men ari
"men" (awarding of the men point in a match)
kote ari
"kote" (awarding of the kote point in a match)
do ari
"do" (awarding of the do point in a match)
tsuki ari
"tsuki" (awarding of the tsuki point)
encho
match overtime period
fusensho
a match win by default, due to the opponent's absence or forfeit
gogi
referee's conference during a match, held in the center of the court
hansoku
match foul, results in one half-point against the offending player
hansoku ikkai
"first hansoku"
hansoku nikai, ippon ari
"second hansoku, one point" (awarded to the opponent of the offending player)
hantei
referees' decision of the winner of a match
hikiwake
match draw
igi
formal protest in a match, registered by a team manager
ippon gachi
a match decided by one point, due to time running out in sanbon-shobu
ippon shobu
one point match (first person to score wins)
jogai
stepping out of bounds (this is a hansoku)
kachinuki
a method of conducting matches in which the winner remains and keeps fighting until defeated
kaishi-sen
starting line in the court
kihon-shiai
tournament in which kihon is judged. Usually includes rei-ho, kiri-kaeshi, and basic uchikomi
kumiawase
tournament match-ups
mejirushi
red or white tag tied to the crossed do strings on the back, used to distinguish the players in a match
nihon me
"Second point" (continues sanbon-shobu after one player has scored the first point of the match)
sanbon shobu
three point match (first person to score two points wins)
shiai-jikan
match time limit
shinai-otoshi
losing control of the shinai (this is a hansoku)
shobu
"Match" (continues sanbon shobu after each player has one point)


WipEout (PSX) – Model Viewer Scene:
Camera:
Free
/
Fly-Through
Music:
Play
/
Pause
Read:
Reverse Engineering WipEout


A
LT
Control
Panel
Toggle navigation
4
You have 4 messages
Support Team
5 mins
Why not buy a new awesome theme?
AdminLTE Design Team
2 hours
Why not buy a new awesome theme?
Developers
Today
Why not buy a new awesome theme?
Sales Department
Yesterday
Why not buy a new awesome theme?
Reviewers
2 days
Why not buy a new awesome theme?
See All Messages
10
You have 10 notifications
5 new members joined today
Very long description here that may not fit into the page and may cause design problems
5 new members joined
25 sales made
You changed your username
View all
9
You have 9 tasks
Design some buttons
20%
20% Complete
Create a nice theme
40%
40% Complete
Some task I need to do
60%
60% Complete
Make beautiful transitions
80%
80% Complete
View all tasks
Awsaf Alam
Alexander Pierce - Web Developer
Member since Nov. 2012
Profile
Sign out
Dashboard
Control panel
Home
Dashboard
Bangladesh
UAE
Saudi Arabia
Oman
United States
United Kingdom
France
Spain
Germany
Thailand
Malaysia
Singapore
Airport Locations
Submit
Airport Information
Airport ID
Name
City
Country
Airport Code
Latitude
Longitude
Altitude
Timezone
Insert Employee
First Name
Last Name
Male
Female
Phone Number
Email ID
Address
Hire Date
Nationality
Salary
Designation


Divide an array into 2 parts
check whether that the averages are same
Length
Enter the length of the array
Array :
Enter the array elements seperated by space
Submit
Reset


Expat is a library, written in C, for parsing XML documents. It's
the underlying XML parser for the open source Mozilla project, Perl's
XML::Parser
, Python's xml.parsers.expat
, and
other open-source XML parsers.
This library is the creation of James Clark, who's also given us groff (an nroff look-alike), Jade (an implemention of ISO's DSSSL stylesheet language for SGML), XP (a Java XML parser package), XT (a Java XSL engine). James was also the technical lead on the XML Working Group at W3C that produced the XML specification.
This is free software, licensed under the MIT/X Consortium license. You may download it from the Expat home page.
The bulk of this document was originally commissioned as an article by XML.com. They graciously allowed Clark Cooper to retain copyright and to distribute it with Expat. This version has been substantially extended to include documentation on features which have been added since the original article was published, and additional information on using the original interface.
Table of Contents
- Overview
- Building and Installing
- Using Expat
- Reference
- Parser Creation Functions
- Parsing Functions
- Handler Setting Functions
- XML_SetStartElementHandler
- XML_SetEndElementHandler
- XML_SetElementHandler
- XML_SetCharacterDataHandler
- XML_SetProcessingInstructionHandler
- XML_SetCommentHandler
- XML_SetStartCdataSectionHandler
- XML_SetEndCdataSectionHandler
- XML_SetCdataSectionHandler
- XML_SetDefaultHandler
- XML_SetDefaultHandlerExpand
- XML_SetExternalEntityRefHandler
- XML_SetExternalEntityRefHandlerArg
- XML_SetSkippedEntityHandler
- XML_SetUnknownEncodingHandler
- XML_SetStartNamespaceDeclHandler
- XML_SetEndNamespaceDeclHandler
- XML_SetNamespaceDeclHandler
- XML_SetXmlDeclHandler
- XML_SetStartDoctypeDeclHandler
- XML_SetEndDoctypeDeclHandler
- XML_SetDoctypeDeclHandler
- XML_SetElementDeclHandler
- XML_SetAttlistDeclHandler
- XML_SetEntityDeclHandler
- XML_SetUnparsedEntityDeclHandler
- XML_SetNotationDeclHandler
- XML_SetNotStandaloneHandler
- Parse Position and Error Reporting Functions
- Miscellaneous Functions
- XML_SetUserData
- XML_GetUserData
- XML_UseParserAsHandlerArg
- XML_SetBase
- XML_GetBase
- XML_GetSpecifiedAttributeCount
- XML_GetIdAttributeIndex
- XML_SetEncoding
- XML_SetParamEntityParsing
- XML_UseForeignDTD
- XML_SetReturnNSTriplet
- XML_DefaultCurrent
- XML_ExpatVersion
- XML_ExpatVersionInfo
- XML_GetFeatureList
- XML_FreeContentModel
- XML_MemMalloc
- XML_MemRealloc
- XML_MemFree
Overview
Expat is a stream-oriented parser. You register callback (or handler) functions with the parser and then start feeding it the document. As the parser recognizes parts of the document, it will call the appropriate handler for that part (if you've registered one.) The document is fed to the parser in pieces, so you can start parsing before you have all the document. This also allows you to parse really huge documents that won't fit into memory.
Expat can be intimidating due to the many kinds of handlers and options you can set. But you only need to learn four functions in order to do 90% of what you'll want to do with it:
XML_ParserCreate
- Create a new parser object.
XML_SetElementHandler
- Set handlers for start and end tags.
XML_SetCharacterDataHandler
- Set handler for text.
XML_Parse
- Pass a buffer full of document to the parser
These functions and others are described in the reference part of this document. The reference section also describes in detail the parameters passed to the different types of handlers.
Let's look at a very simple example program that only uses 3 of the
above functions (it doesn't need to set a character handler.) The
program outline.c prints an
element outline, indenting child elements to distinguish them from the
parent element that contains them. The start handler does all the
work. It prints two indenting spaces for every level of ancestor
elements, then it prints the element and attribute
information. Finally it increments the global Depth
variable.
int Depth; void XMLCALL start(void *data, const char *el, const char **attr) { int i; for (i = 0; i < Depth; i++) printf(" "); printf("%s", el); for (i = 0; attr[i]; i += 2) { printf(" %s='%s'", attr[i], attr[i + 1]); } printf("\n"); Depth++; } /* End of start handler */
The end tag simply does the bookkeeping work of decrementing
Depth
.
void XMLCALL end(void *data, const char *el) { Depth--; } /* End of end handler */
Note the XMLCALL
annotation used for the callbacks.
This is used to ensure that the Expat and the callbacks are using the
same calling convention in case the compiler options used for Expat
itself and the client code are different. Expat tries not to care
what the default calling convention is, though it may require that it
be compiled with a default convention of "cdecl" on some platforms.
For code which uses Expat, however, the calling convention is
specified by the XMLCALL
annotation on most platforms;
callbacks should be defined using this annotation.
The XMLCALL
annotation was added in Expat 1.95.7, but
existing working Expat applications don't need to add it (since they
are already using the "cdecl" calling convention, or they wouldn't be
working). The annotation is only needed if the default calling
convention may be something other than "cdecl". To use the annotation
safely with older versions of Expat, you can conditionally define it
after including Expat's header file:
#include <expat.h> #ifndef XMLCALL #if defined(_MSC_EXTENSIONS) && !defined(__BEOS__) && !defined(__CYGWIN__) #define XMLCALL __cdecl #elif defined(__GNUC__) #define XMLCALL __attribute__((cdecl)) #else #define XMLCALL #endif #endif
After creating the parser, the main program just has the job of shoveling the document to the parser so that it can do its work.
Building and Installing Expat
The Expat distribution comes as a compressed (with GNU gzip) tar file. You may download the latest version from Source Forge. After unpacking this, cd into the directory. Then follow either the Win32 directions or Unix directions below.
Building under Win32
If you're using the GNU compiler under cygwin, follow the Unix directions in the next section. Otherwise if you have Microsoft's Developer Studio installed, then from Windows Explorer double-click on "expat.dsp" in the lib directory and build and install in the usual manner.
Alternatively, you may download the Win32 binary package that contains the "expat.h" include file and a pre-built DLL.
Building under Unix (or GNU)
First you'll need to run the configure shell script in order to configure the Makefiles and headers for your system.
If you're happy with all the defaults that configure picks for you, and you have permission on your system to install into /usr/local, you can install Expat with this sequence of commands:
./configure make make install
There are some options that you can provide to this script, but the
only one we'll mention here is the --prefix
option. You
can find out all the options available by running configure with just
the --help
option.
By default, the configure script sets things up so that the library
gets installed in /usr/local/lib
and the associated
header file in /usr/local/include
. But if you were to
give the option, --prefix=/home/me/mystuff
, then the
library and header would get installed in
/home/me/mystuff/lib
and
/home/me/mystuff/include
respectively.
Configuring Expat Using the Pre-Processor
Expat's feature set can be configured using a small number of
pre-processor definitions. The definition of this symbols does not
affect the set of entry points for Expat, only the behavior of the API
and the definition of character types in the case of
XML_UNICODE_WCHAR_T
. The symbols are:
- XML_DTD
- Include support for using and reporting DTD-based content. If this is defined, default attribute values from an external DTD subset are reported and attribute value normalization occurs based on the type of attributes defined in the external subset. Without this, Expat has a smaller memory footprint and can be faster, but will not load external entities or process conditional sections. This does not affect the set of functions available in the API.
- XML_NS
- When defined, support for the Namespaces in XML specification is included.
- XML_UNICODE
- When defined, character data reported to the application is
encoded in UTF-16 using wide characters of the type
XML_Char
. This is implied ifXML_UNICODE_WCHAR_T
is defined. - XML_UNICODE_WCHAR_T
- If defined, causes the
XML_Char
character type to be defined using thewchar_t
type; otherwise,unsigned short
is used. Defining this impliesXML_UNICODE
. - XML_LARGE_SIZE
- If defined, causes the
XML_Size
andXML_Index
integer types to be at least 64 bits in size. This is intended to support processing of very large input streams, where the return values ofXML_GetCurrentByteIndex
,XML_GetCurrentLineNumber
andXML_GetCurrentColumnNumber
could overflow. It may not be supported by all compilers, and is turned off by default. - XML_CONTEXT_BYTES
- The number of input bytes of markup context which the parser will
ensure are available for reporting via
XML_GetInputContext
. This is normally set to 1024, and must be set to a positive interger. If this is not defined, the input context will not be available andXML_GetInputContext
will always report NULL. Without this, Expat has a smaller memory footprint and can be faster. - XML_STATIC
- On Windows, this should be set if Expat is going to be linked statically with the code that calls it; this is required to get all the right MSVC magic annotations correct. This is ignored on other platforms.
Using Expat
Compiling and Linking Against Expat
Unless you installed Expat in a location not expected by your
compiler and linker, all you have to do to use Expat in your programs
is to include the Expat header (#include <expat.h>
)
in your files that make calls to it and to tell the linker that it
needs to link against the Expat library. On Unix systems, this would
usually be done with the -lexpat
argument. Otherwise,
you'll need to tell the compiler where to look for the Expat header
and the linker where to find the Expat library. You may also need to
take steps to tell the operating system where to find this library at
run time.
On a Unix-based system, here's what a Makefile might look like when Expat is installed in a standard location:
CC=cc LDFLAGS= LIBS= -lexpat xmlapp: xmlapp.o $(CC) $(LDFLAGS) -o xmlapp xmlapp.o $(LIBS)
If you installed Expat in, say, /home/me/mystuff
, then
the Makefile would look like this:
CC=cc CFLAGS= -I/home/me/mystuff/include LDFLAGS= LIBS= -L/home/me/mystuff/lib -lexpat xmlapp: xmlapp.o $(CC) $(LDFLAGS) -o xmlapp xmlapp.o $(LIBS)
You'd also have to set the environment variable
LD_LIBRARY_PATH
to /home/me/mystuff/lib
(or
to ${LD_LIBRARY_PATH}:/home/me/mystuff/lib
if
LD_LIBRARY_PATH already has some directories in it) in order to run
your application.
Expat Basics
As we saw in the example in the overview, the first step in parsing
an XML document with Expat is to create a parser object. There are three functions in the Expat API for creating a
parser object. However, only two of these (XML_ParserCreate
and XML_ParserCreateNS
) can be used for
constructing a parser for a top-level document. The object returned
by these functions is an opaque pointer (i.e. "expat.h" declares it as
void *) to data with further internal structure. In order to free the
memory associated with this object you must call XML_ParserFree
.
Note that if you have
provided any user data that gets stored in the
parser, then your application is responsible for freeing it prior to
calling XML_ParserFree
.
The objects returned by the parser creation functions are good for parsing only one XML document or external parsed entity. If your application needs to parse many XML documents, then it needs to create a parser object for each one. The best way to deal with this is to create a higher level object that contains all the default initialization you want for your parser objects.
Walking through a document hierarchy with a stream oriented parser will require a good stack mechanism in order to keep track of current context. For instance, to answer the simple question, "What element does this text belong to?" requires a stack, since the parser may have descended into other elements that are children of the current one and has encountered this text on the way out.
The things you're likely to want to keep on a stack are the currently opened element and it's attributes. You push this information onto the stack in the start handler and you pop it off in the end handler.
For some tasks, it is sufficient to just keep information on what the depth of the stack is (or would be if you had one.) The outline program shown above presents one example. Another such task would be skipping over a complete element. When you see the start tag for the element you want to skip, you set a skip flag and record the depth at which the element started. When the end tag handler encounters the same depth, the skipped element has ended and the flag may be cleared. If you follow the convention that the root element starts at 1, then you can use the same variable for skip flag and skip depth.
void init_info(Parseinfo *info) { info->skip = 0; info->depth = 1; /* Other initializations here */ } /* End of init_info */ void XMLCALL rawstart(void *data, const char *el, const char **attr) { Parseinfo *inf = (Parseinfo *) data; if (! inf->skip) { if (should_skip(inf, el, attr)) { inf->skip = inf->depth; } else start(inf, el, attr); /* This does rest of start handling */ } inf->depth++; } /* End of rawstart */ void XMLCALL rawend(void *data, const char *el) { Parseinfo *inf = (Parseinfo *) data; inf->depth--; if (! inf->skip) end(inf, el); /* This does rest of end handling */ if (inf->skip == inf->depth) inf->skip = 0; } /* End rawend */
Notice in the above example the difference in how depth is manipulated in the start and end handlers. The end tag handler should be the mirror image of the start tag handler. This is necessary to properly model containment. Since, in the start tag handler, we incremented depth after the main body of start tag code, then in the end handler, we need to manipulate it before the main body. If we'd decided to increment it first thing in the start handler, then we'd have had to decrement it last thing in the end handler.
Communicating between handlers
In order to be able to pass information between different handlers
without using globals, you'll need to define a data structure to hold
the shared variables. You can then tell Expat (with the XML_SetUserData
function) to pass a
pointer to this structure to the handlers. This is the first
argument received by most handlers. In the reference section, an argument to a callback function is named
userData
and have type void *
if the user
data is passed; it will have the type XML_Parser
if the
parser itself is passed. When the parser is passed, the user data may
be retrieved using XML_GetUserData
.
One common case where multiple calls to a single handler may need
to communicate using an application data structure is the case when
content passed to the character data handler (set by XML_SetCharacterDataHandler
) needs to be accumulated. A
common first-time mistake with any of the event-oriented interfaces to
an XML parser is to expect all the text contained in an element to be
reported by a single call to the character data handler. Expat, like
many other XML parsers, reports such data as a sequence of calls;
there's no way to know when the end of the sequence is reached until a
different callback is made. A buffer referenced by the user data
structure proves both an effective and convenient place to accumulate
character data.
XML Version
Expat is an XML 1.0 parser, and as such never complains based on
the value of the version
pseudo-attribute in the XML
declaration, if present.
If an application needs to check the version number (to support
alternate processing), it should use the XML_SetXmlDeclHandler
function to
set a handler that uses the information in the XML declaration to
determine what to do. This example shows how to check that only a
version number of "1.0"
is accepted:
static int wrong_version; static XML_Parser parser; static void XMLCALL xmldecl_handler(void *userData, const XML_Char *version, const XML_Char *encoding, int standalone) { static const XML_Char Version_1_0[] = {'1', '.', '0', 0}; int i; for (i = 0; i < (sizeof(Version_1_0) / sizeof(Version_1_0[0])); ++i) { if (version[i] != Version_1_0[i]) { wrong_version = 1; /* also clear all other handlers: */ XML_SetCharacterDataHandler(parser, NULL); ... return; } } ... }
Namespace Processing
When the parser is created using the XML_ParserCreateNS
,
function, Expat
performs namespace processing. Under namespace processing, Expat
consumes xmlns
and xmlns:...
attributes,
which declare namespaces for the scope of the element in which they
occur. This means that your start handler will not see these
attributes. Your application can still be informed of these
declarations by setting namespace declaration handlers with XML_SetNamespaceDeclHandler
.
Element type and attribute names that belong to a given namespace
are passed to the appropriate handler in expanded form. By default
this expanded form is a concatenation of the namespace URI, the
separator character (which is the 2nd argument to XML_ParserCreateNS
),
and the local
name (i.e. the part after the colon). Names with undeclared prefixes
are not well-formed when namespace processing is enabled, and will
trigger an error. Unprefixed attribute names are never expanded,
and unprefixed element names are only expanded when they are in the
scope of a default namespace.
However if XML_SetReturnNSTriplet
has been called with a non-zero
do_nst
parameter, then the expanded form for names with
an explicit prefix is a concatenation of: URI, separator, local name,
separator, prefix.
You can set handlers for the start of a namespace declaration and
for the end of a scope of a declaration with the XML_SetNamespaceDeclHandler
function. The StartNamespaceDeclHandler is called prior to the start
tag handler and the EndNamespaceDeclHandler is called after the
corresponding end tag that ends the namespace's scope. The namespace
start handler gets passed the prefix and URI for the namespace. For a
default namespace declaration (xmlns='...'), the prefix will be null.
The URI will be null for the case where the default namespace is being
unset. The namespace end handler just gets the prefix for the closing
scope.
These handlers are called for each declaration. So if, for instance, a start tag had three namespace declarations, then the StartNamespaceDeclHandler would be called three times before the start tag handler is called, once for each declaration.
Character Encodings
While XML is based on Unicode, and every XML processor is required to recognized UTF-8 and UTF-16 (1 and 2 byte encodings of Unicode), other encodings may be declared in XML documents or entities. For the main document, an XML declaration may contain an encoding declaration:
<?xml version="1.0" encoding="ISO-8859-2"?>
External parsed entities may begin with a text declaration, which looks like an XML declaration with just an encoding declaration:
<?xml encoding="Big5"?>
With Expat, you may also specify an encoding at the time of creating a parser. This is useful when the encoding information may come from a source outside the document itself (like a higher level protocol.)
There are four built-in encodings in Expat:
- UTF-8
- UTF-16
- ISO-8859-1
- US-ASCII
Anything else discovered in an encoding declaration or in the
protocol encoding specified in the parser constructor, triggers a call
to the UnknownEncodingHandler
. This handler gets passed
the encoding name and a pointer to an XML_Encoding
data
structure. Your handler must fill in this structure and return
XML_STATUS_OK
if it knows how to deal with the
encoding. Otherwise the handler should return
XML_STATUS_ERROR
. The handler also gets passed a pointer
to an optional application data structure that you may indicate when
you set the handler.
Expat places restrictions on character encodings that it can
support by filling in the XML_Encoding
structure.
include file:
- Every ASCII character that can appear in a well-formed XML document must be represented by a single byte, and that byte must correspond to it's ASCII encoding (except for the characters $@\^'{}~)
- Characters must be encoded in 4 bytes or less.
- All characters encoded must have Unicode scalar values less than or equal to 65535 (0xFFFF)This does not apply to the built-in support for UTF-16 and UTF-8
- No character may be encoded by more that one distinct sequence of bytes
XML_Encoding
contains an array of integers that
correspond to the 1st byte of an encoding sequence. If the value in
the array for a byte is zero or positive, then the byte is a single
byte encoding that encodes the Unicode scalar value contained in the
array. A -1 in this array indicates a malformed byte. If the value is
-2, -3, or -4, then the byte is the beginning of a 2, 3, or 4 byte
sequence respectively. Multi-byte sequences are sent to the convert
function pointed at in the XML_Encoding
structure. This
function should return the Unicode scalar value for the sequence or -1
if the sequence is malformed.
One pitfall that novice Expat users are likely to fall into is that although Expat may accept input in various encodings, the strings that it passes to the handlers are always encoded in UTF-8 or UTF-16 (depending on how Expat was compiled). Your application is responsible for any translation of these strings into other encodings.
Handling External Entity References
Expat does not read or parse external entities directly. Note that
any external DTD is a special case of an external entity. If you've
set no ExternalEntityRefHandler
, then external entity
references are silently ignored. Otherwise, it calls your handler with
the information needed to read and parse the external entity.
Your handler isn't actually responsible for parsing the entity, but
it is responsible for creating a subsidiary parser with XML_ExternalEntityParserCreate
that will do the job. This
returns an instance of XML_Parser
that has handlers and
other data structures initialized from the parent parser. You may then
use XML_Parse
or XML_ParseBuffer
calls against this
parser. Since external entities my refer to other external entities,
your handler should be prepared to be called recursively.
Parsing DTDs
In order to parse parameter entities, before starting the parse,
you must call XML_SetParamEntityParsing
with one of the following
arguments:
XML_PARAM_ENTITY_PARSING_NEVER
- Don't parse parameter entities or the external subset
XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE
- Parse parameter entites and the external subset unless
standalone
was set to "yes" in the XML declaration. XML_PARAM_ENTITY_PARSING_ALWAYS
- Always parse parameter entities and the external subset
In order to read an external DTD, you also have to set an external entity reference handler as described above.
Temporarily Stopping Parsing
Expat 1.95.8 introduces a new feature: its now possible to stop parsing temporarily from within a handler function, even if more data has already been passed into the parser. Applications for this include
- Supporting the XInclude specification.
- Delaying further processing until additional information is available from some other source.
- Adjusting processor load as task priorities shift within an application.
- Stopping parsing completely (simply free or reset the parser instead of resuming in the outer parsing loop). This can be useful if a application-domain error is found in the XML being parsed or if the result of the parse is determined not to be useful after all.
To take advantage of this feature, the main parsing loop of an application needs to support this specifically. It cannot be supported with a parsing loop compatible with Expat 1.95.7 or earlier (though existing loops will continue to work without supporting the stop/resume feature).
An application that uses this feature for a single parser will have the rough structure (in pseudo-code):
fd = open_input() p = create_parser() if parse_xml(p, fd) { /* suspended */ int suspended = 1; while (suspended) { do_something_else() if ready_to_resume() { suspended = continue_parsing(p, fd); } } }
An application that may resume any of several parsers based on input (either from the XML being parsed or some other source) will certainly have more interesting control structures.
This C function could be used for the parse_xml
function mentioned in the pseudo-code above:
#define BUFF_SIZE 10240 /* Parse a document from the open file descriptor 'fd' until the parse is complete (the document has been completely parsed, or there's been an error), or the parse is stopped. Return non-zero when the parse is merely suspended. */ int parse_xml(XML_Parser p, int fd) { for (;;) { int last_chunk; int bytes_read; enum XML_Status status; void *buff = XML_GetBuffer(p, BUFF_SIZE); if (buff == NULL) { /* handle error... */ return 0; } bytes_read = read(fd, buff, BUFF_SIZE); if (bytes_read < 0) { /* handle error... */ return 0; } status = XML_ParseBuffer(p, bytes_read, bytes_read == 0); switch (status) { case XML_STATUS_ERROR: /* handle error... */ return 0; case XML_STATUS_SUSPENDED: return 1; } if (bytes_read == 0) return 0; } }
The corresponding continue_parsing
function is
somewhat simpler, since it only need deal with the return code from
XML_ResumeParser
; it can
delegate the input handling to the parse_xml
function:
/* Continue parsing a document which had been suspended. The 'p' and 'fd' arguments are the same as passed to parse_xml(). Return non-zero when the parse is suspended. */ int continue_parsing(XML_Parser p, int fd) { enum XML_Status status = XML_ResumeParser(p); switch (status) { case XML_STATUS_ERROR: /* handle error... */ return 0; case XML_ERROR_NOT_SUSPENDED: /* handle error... */ return 0;. case XML_STATUS_SUSPENDED: return 1; } return parse_xml(p, fd); }
Now that we've seen what a mess the top-level parsing loop can
become, what have we gained? Very simply, we can now use the XML_StopParser
function to stop
parsing, without having to go to great lengths to avoid additional
processing that we're expecting to ignore. As a bonus, we get to stop
parsing temporarily, and come back to it when we're
ready.
To stop parsing from a handler function, use the XML_StopParser
function. This function
takes two arguments; the parser being stopped and a flag indicating
whether the parse can be resumed in the future.
Expat Reference
Parser Creation
XML_Parser XMLCALL XML_ParserCreate(const XML_Char *encoding);
- US-ASCII
- UTF-8
- UTF-16
- ISO-8859-1
XML_Parser XMLCALL XML_ParserCreateNS(const XML_Char *encoding, XML_Char sep);
'\0'
: the namespace URI and the local part will be
concatenated without any separator - this is intended to support RDF processors.
It is a programming error to use the null separator with
namespace triplets.
XML_Parser XMLCALL XML_ParserCreate_MM(const XML_Char *encoding, const XML_Memory_Handling_Suite *ms, const XML_Char *sep);
typedef struct { void *(XMLCALL *malloc_fcn)(size_t size); void *(XMLCALL *realloc_fcn)(void *ptr, size_t size); void (XMLCALL *free_fcn)(void *ptr); } XML_Memory_Handling_Suite;
Construct a new parser using the suite of memory handling functions
specified in ms
. If ms
is NULL, then use the
standard set of memory management functions. If sep
is
non NULL, then namespace processing is enabled in the created parser
and the character pointed at by sep is used as the separator between
the namespace URI and the local part of the name.
XML_Parser XMLCALL XML_ExternalEntityParserCreate(XML_Parser p, const XML_Char *context, const XML_Char *encoding);
XML_Parser
object for parsing an external
general entity. Context is the context argument passed in a call to a
ExternalEntityRefHandler. Other state information such as handlers,
user data, namespace processing is inherited from the parser passed as
the 1st argument. So you shouldn't need to call any of the behavior
changing functions on this parser (unless you want it to act
differently than the parent parser).
void XMLCALL XML_ParserFree(XML_Parser p);
XML_Bool XMLCALL XML_ParserReset(XML_Parser p, const XML_Char *encoding);
parser
is
ready to start parsing a new document. All handlers are cleared from
the parser, except for the unknownEncodingHandler. The parser's external
state is re-initialized except for the values of ns and ns_triplets.
This function may not be used on a parser created using XML_ExternalEntityParserCreate
; it will return XML_FALSE
in that case. Returns
XML_TRUE
on success. Your application is responsible for
dealing with any memory associated with user data.
Parsing
To state the obvious: the three parsing functions XML_Parse
,
XML_ParseBuffer
and
XML_GetBuffer
must not be called from within a handler
unless they operate on a separate parser instance, that is, one that
did not call the handler. For example, it is OK to call the parsing
functions from within an XML_ExternalEntityRefHandler
,
if they apply to the parser created by
XML_ExternalEntityParserCreate
.
Note: the len
argument passed to these functions
should be considerably less than the maximum value for an integer,
as it could create an integer overflow situation if the added
lengths of a buffer and the unprocessed portion of the previous buffer
exceed the maximum integer value. Input data at the end of a buffer
will remain unprocessed if it is part of an XML token for which the
end is not part of that buffer.
enum XML_Status XMLCALL XML_Parse(XML_Parser p, const char *s, int len, int isFinal);
enum XML_Status { XML_STATUS_ERROR = 0, XML_STATUS_OK = 1 };
s
is a buffer
containing part (or perhaps all) of the document. The number of bytes of s
that are part of the document is indicated by len
. This means
that s
doesn't have to be null terminated. It also means that
if len
is larger than the number of bytes in the block of
memory that s
points at, then a memory fault is likely. The
isFinal
parameter informs the parser that this is the last
piece of the document. Frequently, the last piece is empty (i.e.
len
is zero.)
If a parse error occurred, it returns XML_STATUS_ERROR
.
Otherwise it returns XML_STATUS_OK
value.
enum XML_Status XMLCALL XML_ParseBuffer(XML_Parser p, int len, int isFinal);
XML_Parse
,
except in this case Expat provides the buffer. By obtaining the
buffer from Expat with the XML_GetBuffer
function, the application can avoid double
copying of the input.
void * XMLCALL XML_GetBuffer(XML_Parser p, int len);
len
to read a piece of the document
into. A NULL value is returned if Expat can't allocate enough memory for
this buffer. This has to be called prior to every call to
XML_ParseBuffer
. A
typical use would look like this:
for (;;) { int bytes_read; void *buff = XML_GetBuffer(p, BUFF_SIZE); if (buff == NULL) { /* handle error */ } bytes_read = read(docfd, buff, BUFF_SIZE); if (bytes_read < 0) { /* handle error */ } if (! XML_ParseBuffer(p, bytes_read, bytes_read == 0)) { /* handle parse error */ } if (bytes_read == 0) break; }
enum XML_Status XMLCALL XML_StopParser(XML_Parser p, XML_Bool resumable);
Stops parsing, causing XML_Parse
or XML_ParseBuffer
to return. Must be called from within a
call-back handler, except when aborting (when resumable
is XML_FALSE
) an already suspended parser. Some
call-backs may still follow because they would otherwise get
lost, including
- the end element handler for empty elements when stopped in the start element handler,
- the end namespace declaration handler when stopped in the end element handler,
- the character data handler when stopped in the character data handler while making multiple call-backs on a contiguous chunk of characters,
This can be called from most handlers, including DTD related
call-backs, except when parsing an external parameter entity and
resumable
is XML_TRUE
. Returns
XML_STATUS_OK
when successful,
XML_STATUS_ERROR
otherwise. The possible error codes
are:
XML_ERROR_SUSPENDED
- when suspending an already suspended parser.
XML_ERROR_FINISHED
- when the parser has already finished.
XML_ERROR_SUSPEND_PE
- when suspending while parsing an external PE.
Since the stop/resume feature requires application support in the outer parsing loop, it is an error to call this function for a parser not being handled appropriately; see Temporarily Stopping Parsing for more information.
When resumable
is XML_TRUE
then parsing
is suspended, that is, XML_Parse
and XML_ParseBuffer
return XML_STATUS_SUSPENDED
.
Otherwise, parsing is aborted, that is, XML_Parse
and XML_ParseBuffer
return
XML_STATUS_ERROR
with error code
XML_ERROR_ABORTED
.
Note:
This will be applied to the current parser instance only, that is, if
there is a parent parser then it will continue parsing when the
external entity reference handler returns. It is up to the
implementation of that handler to call XML_StopParser
on the parent parser
(recursively), if one wants to stop parsing altogether.
When suspended, parsing can be resumed by calling XML_ResumeParser
.
New in Expat 1.95.8.
enum XML_Status XMLCALL XML_ResumeParser(XML_Parser p);
Resumes parsing after it has been suspended with XML_StopParser
.
Must not be called from
within a handler call-back. Returns same status codes as XML_Parse
or XML_ParseBuffer
.
An additional error
code, XML_ERROR_NOT_SUSPENDED
, will be returned if the
parser was not currently suspended.
Note:
This must be called on the most deeply nested child parser instance
first, and on its parent parser only after the child parser has
finished, to be applied recursively until the document entity's parser
is restarted. That is, the parent parser will not resume by itself
and it is up to the application to call XML_ResumeParser
on it at the
appropriate moment.
New in Expat 1.95.8.
void XMLCALL XML_GetParsingStatus(XML_Parser p, XML_ParsingStatus *status);
enum XML_Parsing { XML_INITIALIZED, XML_PARSING, XML_FINISHED, XML_SUSPENDED }; typedef struct { enum XML_Parsing parsing; XML_Bool finalBuffer; } XML_ParsingStatus;
Returns status of parser with respect to being initialized,
parsing, finished, or suspended, and whether the final buffer is being
processed. The status
parameter must not be
NULL.
New in Expat 1.95.8.
Handler Setting
Although handlers are typically set prior to parsing and left alone, an
application may choose to set or change the handler for a parsing event
while the parse is in progress. For instance, your application may choose
to ignore all text not descended from a para
element. One
way it could do this is to set the character handler when a para start tag
is seen, and unset it for the corresponding end tag.
A handler may be unset by providing a NULL pointer to the appropriate handler setter. None of the handler setting functions have a return value.
Your handlers will be receiving strings in arrays of type
XML_Char
. This type is conditionally defined in expat.h as
either char
, wchar_t
or unsigned short
.
The former implies UTF-8 encoding, the latter two imply UTF-16 encoding.
Note that you'll receive them in this form independent of the original
encoding of the document.
void XMLCALL XML_SetStartElementHandler(XML_Parser p, XML_StartElementHandler start);
typedef void (XMLCALL *XML_StartElementHandler)(void *userData, const XML_Char *name, const XML_Char **atts);
Set handler for start (and empty) tags. Attributes are passed to the start handler as a pointer to a vector of char pointers. Each attribute seen in a start (or empty) tag occupies 2 consecutive places in this vector: the attribute name followed by the attribute value. These pairs are terminated by a null pointer.
Note that an empty tag generates a call to both start and end handlers (in that order).
void XMLCALL XML_SetEndElementHandler(XML_Parser p, XML_EndElementHandler);
typedef void (XMLCALL *XML_EndElementHandler)(void *userData, const XML_Char *name);
Set handler for end (and empty) tags. As noted above, an empty tag generates a call to both start and end handlers.
void XMLCALL XML_SetElementHandler(XML_Parser p, XML_StartElementHandler start, XML_EndElementHandler end);
Set handlers for start and end tags with one call.
void XMLCALL XML_SetCharacterDataHandler(XML_Parser p, XML_CharacterDataHandler charhndl)
typedef void (XMLCALL *XML_CharacterDataHandler)(void *userData, const XML_Char *s, int len);
Set a text handler. The string your handler receives is NOT nul-terminated. You have to use the length argument to deal with the end of the string. A single block of contiguous text free of markup may still result in a sequence of calls to this handler. In other words, if you're searching for a pattern in the text, it may be split across calls to this handler. Note: Setting this handler to NULL may NOT immediately terminate call-backs if the parser is currently processing such a single block of contiguous markup-free text, as the parser will continue calling back until the end of the block is reached.
void XMLCALL XML_SetProcessingInstructionHandler(XML_Parser p, XML_ProcessingInstructionHandler proc)
typedef void (XMLCALL *XML_ProcessingInstructionHandler)(void *userData, const XML_Char *target, const XML_Char *data);
Set a handler for processing instructions. The target is the first word in the processing instruction. The data is the rest of the characters in it after skipping all whitespace after the initial word.
void XMLCALL XML_SetCommentHandler(XML_Parser p, XML_CommentHandler cmnt)
typedef void (XMLCALL *XML_CommentHandler)(void *userData, const XML_Char *data);
Set a handler for comments. The data is all text inside the comment delimiters.
void XMLCALL XML_SetStartCdataSectionHandler(XML_Parser p, XML_StartCdataSectionHandler start);
typedef void (XMLCALL *XML_StartCdataSectionHandler)(void *userData);
Set a handler that gets called at the beginning of a CDATA section.
void XMLCALL XML_SetEndCdataSectionHandler(XML_Parser p, XML_EndCdataSectionHandler end);
typedef void (XMLCALL *XML_EndCdataSectionHandler)(void *userData);
Set a handler that gets called at the end of a CDATA section.
void XMLCALL XML_SetCdataSectionHandler(XML_Parser p, XML_StartCdataSectionHandler start, XML_EndCdataSectionHandler end)
Sets both CDATA section handlers with one call.
void XMLCALL XML_SetDefaultHandler(XML_Parser p, XML_DefaultHandler hndl)
typedef void (XMLCALL *XML_DefaultHandler)(void *userData, const XML_Char *s, int len);
Sets a handler for any characters in the document which wouldn't otherwise be handled. This includes both data for which no handlers can be set (like some kinds of DTD declarations) and data which could be reported but which currently has no handler set. The characters are passed exactly as they were present in the XML document except that they will be encoded in UTF-8 or UTF-16. Line boundaries are not normalized. Note that a byte order mark character is not passed to the default handler. There are no guarantees about how characters are divided between calls to the default handler: for example, a comment might be split between multiple calls. Setting the handler with this call has the side effect of turning off expansion of references to internally defined general entities. Instead these references are passed to the default handler.
See also XML_DefaultCurrent
.
void XMLCALL XML_SetDefaultHandlerExpand(XML_Parser p, XML_DefaultHandler hndl)
typedef void (XMLCALL *XML_DefaultHandler)(void *userData, const XML_Char *s, int len);
This sets a default handler, but doesn't inhibit the expansion of internal entity references. The entity reference will not be passed to the default handler.
See also XML_DefaultCurrent
.
void XMLCALL XML_SetExternalEntityRefHandler(XML_Parser p, XML_ExternalEntityRefHandler hndl)
typedef int (XMLCALL *XML_ExternalEntityRefHandler)(XML_Parser p, const XML_Char *context, const XML_Char *base, const XML_Char *systemId, const XML_Char *publicId);
Set an external entity reference handler. This handler is also
called for processing an external DTD subset if parameter entity parsing
is in effect. (See
XML_SetParamEntityParsing
.)
The context
parameter specifies the parsing context in
the format expected by the context
argument to XML_ExternalEntityParserCreate
. code
is
valid only until the handler returns, so if the referenced entity is
to be parsed later, it must be copied. context
is NULL
only when the entity is a parameter entity, which is how one can
differentiate between general and parameter entities.
The base
parameter is the base to use for relative
system identifiers. It is set by XML_SetBase
and may be NULL. The
publicId
parameter is the public id given in the entity
declaration and may be NULL. systemId
is the system
identifier specified in the entity declaration and is never NULL.
There are a couple of ways in which this handler differs from
others. First, this handler returns a status indicator (an
integer). XML_STATUS_OK
should be returned for successful
handling of the external entity reference. Returning
XML_STATUS_ERROR
indicates failure, and causes the
calling parser to return an
XML_ERROR_EXTERNAL_ENTITY_HANDLING
error.
Second, instead of having the user data as its first argument, it
receives the parser that encountered the entity reference. This, along
with the context parameter, may be used as arguments to a call to
XML_ExternalEntityParserCreate
. Using the returned
parser, the body of the external entity can be recursively parsed.
Since this handler may be called recursively, it should not be saving information into global or static variables.
void XMLCALL XML_SetExternalEntityRefHandlerArg(XML_Parser p, void *arg)
Set the argument passed to the ExternalEntityRefHandler. If
arg
is not NULL, it is the new value passed to the
handler set using XML_SetExternalEntityRefHandler
; if arg
is
NULL, the argument passed to the handler function will be the parser
object itself.
Note:
The type of arg
and the type of the first argument to the
ExternalEntityRefHandler do not match. This function takes a
void *
to be passed to the handler, while the handler
accepts an XML_Parser
. This is a historical accident,
but will not be corrected before Expat 2.0 (at the earliest) to avoid
causing compiler warnings for code that's known to work with this
API. It is the responsibility of the application code to know the
actual type of the argument passed to the handler and to manage it
properly.
void XMLCALL XML_SetSkippedEntityHandler(XML_Parser p, XML_SkippedEntityHandler handler)
typedef void (XMLCALL *XML_SkippedEntityHandler)(void *userData, const XML_Char *entityName, int is_parameter_entity);
Set a skipped entity handler. This is called in two situations:
- An entity reference is encountered for which no declaration has been read and this is not an error.
- An internal entity reference is read, but not expanded, because
XML_SetDefaultHandler
has been called.
The is_parameter_entity
argument will be non-zero for
a parameter entity and zero for a general entity.
Note: skipped parameter entities in declarations and skipped general entities in attribute values cannot be reported, because the event would be out of sync with the reporting of the declarations or attribute values
void XMLCALL XML_SetUnknownEncodingHandler(XML_Parser p, XML_UnknownEncodingHandler enchandler, void *encodingHandlerData)
typedef int (XMLCALL *XML_UnknownEncodingHandler)(void *encodingHandlerData, const XML_Char *name, XML_Encoding *info); typedef struct { int map[256]; void *data; int (XMLCALL *convert)(void *data, const char *s); void (XMLCALL *release)(void *data); } XML_Encoding;
Set a handler to deal with encodings other than the built in set. This should be done before
XML_Parse
or XML_ParseBuffer
have been called on the
given parser.
If the handler knows how to deal with an encoding
with the given name, it should fill in the info
data
structure and return XML_STATUS_OK
. Otherwise it
should return XML_STATUS_ERROR
. The handler will be called
at most once per parsed (external) entity. The optional application
data pointer encodingHandlerData
will be passed back to
the handler.
The map array contains information for every possible possible leading
byte in a byte sequence. If the corresponding value is >= 0, then it's
a single byte sequence and the byte encodes that Unicode value. If the
value is -1, then that byte is invalid as the initial byte in a sequence.
If the value is -n, where n is an integer > 1, then n is the number of
bytes in the sequence and the actual conversion is accomplished by a
call to the function pointed at by convert. This function may return -1
if the sequence itself is invalid. The convert pointer may be null if
there are only single byte codes. The data parameter passed to the convert
function is the data pointer from XML_Encoding
. The
string s is NOT nul-terminated and points at the sequence of
bytes to be converted.
The function pointed at by release
is called by the
parser when it is finished with the encoding. It may be NULL.
void XMLCALL XML_SetStartNamespaceDeclHandler(XML_Parser p, XML_StartNamespaceDeclHandler start);
typedef void (XMLCALL *XML_StartNamespaceDeclHandler)(void *userData, const XML_Char *prefix, const XML_Char *uri);
Set a handler to be called when a namespace is declared. Namespace declarations occur inside start tags. But the namespace declaration start handler is called before the start tag handler for each namespace declared in that start tag.
void XMLCALL XML_SetEndNamespaceDeclHandler(XML_Parser p, XML_EndNamespaceDeclHandler end);
typedef void (XMLCALL *XML_EndNamespaceDeclHandler)(void *userData, const XML_Char *prefix);
Set a handler to be called when leaving the scope of a namespace declaration. This will be called, for each namespace declaration, after the handler for the end tag of the element in which the namespace was declared.
void XMLCALL XML_SetNamespaceDeclHandler(XML_Parser p, XML_StartNamespaceDeclHandler start, XML_EndNamespaceDeclHandler end)
Sets both namespace declaration handlers with a single call.
void XMLCALL XML_SetXmlDeclHandler(XML_Parser p, XML_XmlDeclHandler xmldecl);
typedef void (XMLCALL *XML_XmlDeclHandler)(void *userData, const XML_Char *version, const XML_Char *encoding, int standalone);
Sets a handler that is called for XML declarations and also for
text declarations discovered in external entities. The way to
distinguish is that the version
parameter will be NULL
for text declarations. The encoding
parameter may be NULL
for an XML declaration. The standalone
argument will
contain -1, 0, or 1 indicating respectively that there was no
standalone parameter in the declaration, that it was given as no, or
that it was given as yes.
void XMLCALL XML_SetStartDoctypeDeclHandler(XML_Parser p, XML_StartDoctypeDeclHandler start);
typedef void (XMLCALL *XML_StartDoctypeDeclHandler)(void *userData, const XML_Char *doctypeName, const XML_Char *sysid, const XML_Char *pubid, int has_internal_subset);
Set a handler that is called at the start of a DOCTYPE declaration,
before any external or internal subset is parsed. Both sysid
and pubid
may be NULL. The has_internal_subset
will be non-zero if the DOCTYPE declaration has an internal subset.
void XMLCALL XML_SetEndDoctypeDeclHandler(XML_Parser p, XML_EndDoctypeDeclHandler end);
typedef void (XMLCALL *XML_EndDoctypeDeclHandler)(void *userData);
Set a handler that is called at the end of a DOCTYPE declaration, after parsing any external subset.
void XMLCALL XML_SetDoctypeDeclHandler(XML_Parser p, XML_StartDoctypeDeclHandler start, XML_EndDoctypeDeclHandler end);
Set both doctype handlers with one call.
void XMLCALL XML_SetElementDeclHandler(XML_Parser p, XML_ElementDeclHandler eldecl);
typedef void (XMLCALL *XML_ElementDeclHandler)(void *userData, const XML_Char *name, XML_Content *model);
enum XML_Content_Type { XML_CTYPE_EMPTY = 1, XML_CTYPE_ANY, XML_CTYPE_MIXED, XML_CTYPE_NAME, XML_CTYPE_CHOICE, XML_CTYPE_SEQ }; enum XML_Content_Quant { XML_CQUANT_NONE, XML_CQUANT_OPT, XML_CQUANT_REP, XML_CQUANT_PLUS }; typedef struct XML_cp XML_Content; struct XML_cp { enum XML_Content_Type type; enum XML_Content_Quant quant; const XML_Char * name; unsigned int numchildren; XML_Content * children; };
Sets a handler for element declarations in a DTD. The handler gets
called with the name of the element in the declaration and a pointer
to a structure that contains the element model. It is the
application's responsibility to free this data structure using
XML_FreeContentModel
.
The model
argument is the root of a tree of
XML_Content
nodes. If type
equals
XML_CTYPE_EMPTY
or XML_CTYPE_ANY
, then
quant
will be XML_CQUANT_NONE
, and the other
fields will be zero or NULL. If type
is
XML_CTYPE_MIXED
, then quant
will be
XML_CQUANT_NONE
or XML_CQUANT_REP
and
numchildren
will contain the number of elements that are
allowed to be mixed in and children
points to an array of
XML_Content
structures that will all have type
XML_CTYPE_NAME with no quantification. Only the root node can be type
XML_CTYPE_EMPTY
, XML_CTYPE_ANY
, or
XML_CTYPE_MIXED
.
For type XML_CTYPE_NAME
, the name
field
points to the name and the numchildren
and
children
fields will be zero and NULL. The
quant
field will indicate any quantifiers placed on the
name.
Types XML_CTYPE_CHOICE
and XML_CTYPE_SEQ
indicate a choice or sequence respectively. The
numchildren
field indicates how many nodes in the choice
or sequence and children
points to the nodes.
void XMLCALL XML_SetAttlistDeclHandler(XML_Parser p, XML_AttlistDeclHandler attdecl);
typedef void (XMLCALL *XML_AttlistDeclHandler)(void *userData, const XML_Char *elname, const XML_Char *attname, const XML_Char *att_type, const XML_Char *dflt, int isrequired);
Set a handler for attlist declarations in the DTD. This handler is
called for each attribute. So a single attlist declaration
with multiple attributes declared will generate multiple calls to this
handler. The elname
parameter returns the name of the
element for which the attribute is being declared. The attribute name
is in the attname
parameter. The attribute type is in the
att_type
parameter. It is the string representing the
type in the declaration with whitespace removed.
The dflt
parameter holds the default value. It will be
NULL in the case of "#IMPLIED" or "#REQUIRED" attributes. You can
distinguish these two cases by checking the isrequired
parameter, which will be true in the case of "#REQUIRED" attributes.
Attributes which are "#FIXED" will have also have a true
isrequired
, but they will have the non-NULL fixed value
in the dflt
parameter.
void XMLCALL XML_SetEntityDeclHandler(XML_Parser p, XML_EntityDeclHandler handler);
typedef void (XMLCALL *XML_EntityDeclHandler)(void *userData, const XML_Char *entityName, int is_parameter_entity, const XML_Char *value, int value_length, const XML_Char *base, const XML_Char *systemId, const XML_Char *publicId, const XML_Char *notationName);
Sets a handler that will be called for all entity declarations.
The is_parameter_entity
argument will be non-zero in the
case of parameter entities and zero otherwise.
For internal entities (<!ENTITY foo "bar">
),
value
will be non-NULL and systemId
,
publicId
, and notationName
will all be NULL.
The value string is not NULL terminated; the length is
provided in the value_length
parameter. Do not use
value_length
to test for internal entities, since it is
legal to have zero-length values. Instead check for whether or not
value
is NULL.
The notationName
argument will have a non-NULL value only for unparsed entity
declarations.
void XMLCALL XML_SetUnparsedEntityDeclHandler(XML_Parser p, XML_UnparsedEntityDeclHandler h)
typedef void (XMLCALL *XML_UnparsedEntityDeclHandler)(void *userData, const XML_Char *entityName, const XML_Char *base, const XML_Char *systemId, const XML_Char *publicId, const XML_Char *notationName);
Set a handler that receives declarations of unparsed entities. These are entity declarations that have a notation (NDATA) field:
<!ENTITY logo SYSTEM "images/logo.gif" NDATA gif>
This handler is obsolete and is provided for backwards compatibility. Use instead XML_SetEntityDeclHandler.
void XMLCALL XML_SetNotationDeclHandler(XML_Parser p, XML_NotationDeclHandler h)
typedef void (XMLCALL *XML_NotationDeclHandler)(void *userData, const XML_Char *notationName, const XML_Char *base, const XML_Char *systemId, const XML_Char *publicId);
Set a handler that receives notation declarations.
void XMLCALL XML_SetNotStandaloneHandler(XML_Parser p, XML_NotStandaloneHandler h)
typedef int (XMLCALL *XML_NotStandaloneHandler)(void *userData);
Set a handler that is called if the document is not "standalone".
This happens when there is an external subset or a reference to a
parameter entity, but does not have standalone set to "yes" in an XML
declaration. If this handler returns XML_STATUS_ERROR
,
then the parser will throw an XML_ERROR_NOT_STANDALONE
error.
Parse position and error reporting functions
These are the functions you'll want to call when the parse
functions return XML_STATUS_ERROR
(a parse error has
occurred), although the position reporting functions are useful outside
of errors. The position reported is the byte position (in the original
document or entity encoding) of the first of the sequence of
characters that generated the current event (or the error that caused
the parse functions to return XML_STATUS_ERROR
.) The
exceptions are callbacks trigged by declarations in the document
prologue, in which case they exact position reported is somewhere in the
relevant markup, but not necessarily as meaningful as for other
events.
The position reporting functions are accurate only outside of the DTD. In other words, they usually return bogus information when called from within a DTD declaration handler.
enum XML_Error XMLCALL XML_GetErrorCode(XML_Parser p);
const XML_LChar * XMLCALL XML_ErrorString(enum XML_Error code);
XML_GetErrorCode
.
XML_Index XMLCALL XML_GetCurrentByteIndex(XML_Parser p);
XML_GetCurrentLineNumber
and XML_GetCurrentColumnNumber
.
XML_Size XMLCALL XML_GetCurrentLineNumber(XML_Parser p);
1
.
XML_Size XMLCALL XML_GetCurrentColumnNumber(XML_Parser p);
int XMLCALL XML_GetCurrentByteCount(XML_Parser p);
0
if the event is inside a reference to an internal
entity and for the end-tag event for empty element tags (the later can
be used to distinguish empty-element tags from empty elements using
separate start and end tags).
const char * XMLCALL XML_GetInputContext(XML_Parser p, int *offset, int *size);
Returns the parser's input buffer, sets the integer pointed at by
offset
to the offset within this buffer of the current
parse position, and set the integer pointed at by size
to
the size of the returned buffer.
This should only be called from within a handler during an active parse and the returned buffer should only be referred to from within the handler that made the call. This input buffer contains the untranslated bytes of the input.
Only a limited amount of context is kept, so if the event triggering a call spans over a very large amount of input, the actual parse position may be before the beginning of the buffer.
If XML_CONTEXT_BYTES
is not defined, this will always
return NULL.
Miscellaneous functions
The functions in this section either obtain state information from the parser or can be used to dynamicly set parser options.
void XMLCALL XML_SetUserData(XML_Parser p, void *userData);
userData
when it is finished with the parser. So if you
call this when there's already a pointer there, and you haven't freed
the memory associated with it, then you've probably just leaked
memory.
void * XMLCALL XML_GetUserData(XML_Parser p);
void XMLCALL XML_UseParserAsHandlerArg(XML_Parser p);
userData
arguments. The user data can still be obtained
using the XML_GetUserData
function.
enum XML_Status XMLCALL XML_SetBase(XML_Parser p, const XML_Char *base);
XML_STATUS_ERROR
if
there's no memory to store base, otherwise it's
XML_STATUS_OK
.
const XML_Char * XMLCALL XML_GetBase(XML_Parser p);
int XMLCALL XML_GetSpecifiedAttributeCount(XML_Parser p);
atts
array passed to the start tag handler of the first
attribute set due to defaults. It supplies information for the last
call to a start handler. If called inside a start handler, then that
means the current call.
int XMLCALL XML_GetIdAttributeIndex(XML_Parser p);
XML_StartElementHandler
, or -1 if there is no ID
attribute. If called inside a start handler, then that means the
current call.
enum XML_Status XMLCALL XML_SetEncoding(XML_Parser p, const XML_Char *encoding);
XML_Parse
or XML_ParseBuffer
have been called on the given parser.
Returns XML_STATUS_OK
on success or
XML_STATUS_ERROR
on error.
int XMLCALL XML_SetParamEntityParsing(XML_Parser p, enum XML_ParamEntityParsing code);
code
.
The choices for code
are:
XML_PARAM_ENTITY_PARSING_NEVER
XML_PARAM_ENTITY_PARSING_UNLESS_STANDALONE
XML_PARAM_ENTITY_PARSING_ALWAYS
enum XML_Error XMLCALL XML_UseForeignDTD(XML_Parser parser, XML_Bool useDTD);
This function allows an application to provide an external subset
for the document type declaration for documents which do not specify
an external subset of their own. For documents which specify an
external subset in their DOCTYPE declaration, the application-provided
subset will be ignored. If the document does not contain a DOCTYPE
declaration at all and useDTD
is true, the
application-provided subset will be parsed, but the
startDoctypeDeclHandler
and
endDoctypeDeclHandler
functions, if set, will not be
called. The setting of parameter entity parsing, controlled using
XML_SetParamEntityParsing
, will be honored.
The application-provided external subset is read by calling the
external entity reference handler set via XML_SetExternalEntityRefHandler
with both
publicId
and systemId
set to NULL.
If this function is called after parsing has begun, it returns
XML_ERROR_CANT_CHANGE_FEATURE_ONCE_PARSING
and ignores
useDTD
. If called when Expat has been compiled without
DTD support, it returns
XML_ERROR_FEATURE_REQUIRES_XML_DTD
. Otherwise, it
returns XML_ERROR_NONE
.
Note: For the purpose of checking WFC: Entity Declared, passing
useDTD == XML_TRUE
will make the parser behave as if
the document had a DTD with an external subset. This holds true even if
the external entity reference handler returns without action.
void XMLCALL XML_SetReturnNSTriplet(XML_Parser parser, int do_nst);
This function only has an effect when using a parser created with
XML_ParserCreateNS
,
i.e. when namespace processing is in effect. The do_nst
sets whether or not prefixes are returned with names qualified with a
namespace prefix. If this function is called with do_nst
non-zero, then afterwards namespace qualified names (that is qualified
with a prefix as opposed to belonging to a default namespace) are
returned as a triplet with the three parts separated by the namespace
separator specified when the parser was created. The order of
returned parts is URI, local name, and prefix.
If
do_nst
is zero, then namespaces are reported in the
default manner, URI then local_name separated by the namespace
separator.
void XMLCALL XML_DefaultCurrent(XML_Parser parser);
XML_SetDefaultHandler
or
XML_SetDefaultHandlerExpand
. It does nothing if there is
not a default handler.
XML_LChar * XMLCALL XML_ExpatVersion();
"expat_1.95.1"
).
struct XML_Expat_Version XMLCALL XML_ExpatVersionInfo();
typedef struct { int major; int minor; int micro; } XML_Expat_Version;
XML_MAJOR_VERSION
XML_MINOR_VERSION
XML_MICRO_VERSION
const XML_Feature * XMLCALL XML_GetFeatureList();
enum XML_FeatureEnum { XML_FEATURE_END = 0, XML_FEATURE_UNICODE, XML_FEATURE_UNICODE_WCHAR_T, XML_FEATURE_DTD, XML_FEATURE_CONTEXT_BYTES, XML_FEATURE_MIN_SIZE, XML_FEATURE_SIZEOF_XML_CHAR, XML_FEATURE_SIZEOF_XML_LCHAR, XML_FEATURE_NS, XML_FEATURE_LARGE_SIZE }; typedef struct { enum XML_FeatureEnum feature; XML_LChar *name; long int value; } XML_Feature;
Returns a list of "feature" records, providing details on how Expat was configured at compile time. Most applications should not need to worry about this, but this information is otherwise not available from Expat. This function allows code that does need to check these features to do so at runtime.
The return value is an array of XML_Feature
,
terminated by a record with a feature
of
XML_FEATURE_END
and name
of NULL,
identifying the feature-test macros Expat was compiled with. Since an
application that requires this kind of information needs to determine
the type of character the name
points to, records for the
XML_FEATURE_SIZEOF_XML_CHAR
and
XML_FEATURE_SIZEOF_XML_LCHAR
will be located at the
beginning of the list, followed by XML_FEATURE_UNICODE
and XML_FEATURE_UNICODE_WCHAR_T
, if they are present at
all.
Some features have an associated value. If there isn't an
associated value, the value
field is set to 0. At this
time, the following features have been defined to have values:
XML_FEATURE_SIZEOF_XML_CHAR
- The number of bytes occupied by one
XML_Char
character. XML_FEATURE_SIZEOF_XML_LCHAR
- The number of bytes occupied by one
XML_LChar
character. XML_FEATURE_CONTEXT_BYTES
- The maximum number of characters of context which can be
reported by
XML_GetInputContext
.
void XMLCALL XML_FreeContentModel(XML_Parser parser, XML_Content *model);
model
argument passed to the
XML_ElementDeclHandler
callback set using XML_ElementDeclHandler
.
This function should not be used for any other purpose.
The following functions allow external code to share the memory
allocator an XML_Parser
has been configured to use. This
is especially useful for third-party libraries that interact with a
parser object created by application code, or heavily layered
applications. This can be essential when using dynamically loaded
libraries which use different C standard libraries (this can happen on
Windows, at least).
void * XMLCALL XML_MemMalloc(XML_Parser parser, size_t size);
size
bytes of memory using the allocator the
parser
object has been configured to use. Returns a
pointer to the memory or NULL on failure. Memory allocated in this
way must be freed using XML_MemFree
.
void * XMLCALL XML_MemRealloc(XML_Parser parser, void *ptr, size_t size);
size
bytes of memory using the allocator the
parser
object has been configured to use.
ptr
must point to a block of memory allocated by XML_MemMalloc
or
XML_MemRealloc
, or be NULL. This function tries to
expand the block pointed to by ptr
if possible. Returns
a pointer to the memory or NULL on failure. On success, the original
block has either been expanded or freed. On failure, the original
block has not been freed; the caller is responsible for freeing the
original block. Memory allocated in this way must be freed using
XML_MemFree
.
void XMLCALL XML_MemFree(XML_Parser parser, void *ptr);
ptr
. The block must
have been allocated by XML_MemMalloc
or XML_MemRealloc
, or be NULL.


Sam is a nephilem of great power, she bears the prophetic title of Echidna as the one who will bring about the return of monsters and magic. Due to her nature she is considered one of the most influential figures in the world by those aware of her existence.
Sam is capable of most known magic, and possesses the ability to use magic and science together to make otherwise impossible spells and devices. Due to her title, she is immune to mental assault, but lacks offensive power in the same department. She is known in particular for being able to heal even age from people, and to transmute entire junkyards into neat blocks of different elements. She bears the Sin of Pride.
When Sam began to awaken as Echidna, one of the very first people she summoned was Arram, an archmage from the previous Era who had been trapped in time due to a miscalculated spell
As per his rank, Arram is a mage of incredible power who is often underestimated due to his easygoing attitude. He possess invaluable knowledge about the previous Era and its magicks and creatures. He has a Cloudkeeper Dragon as a bonded Familiar, nicknamed Demi.
Due to a fertility ritual gone horribly wrong, Sam was able to get pregnant as a Nephilem, with her vampire husband Thomas. Their only child, a little girl named Alice.
Alice is a strange case, due to her Nephilem heritage she grew and developed quickly until she reached the physical age of about 14 by the time she was years old. She possess the title of Dreamseer and can not only visit other peoples dreams, but record them from memory and modify them at will regardless of distance. She bears the Sin of Gluttony
Corrin is a regular human who got into The School on full scholarship just like Sam. His backstory and family history isn't a pretty one, but he's managed to be Sam's roommate since she started at school. The two maintain a very close platonic relationship as Corrin is in a relationship with Blake, Robin's roommate and the two of them consider each other something akin to brother and sister
Due to accidental teaching, Corrin has learned how to use Magic, and seems to specialize in Illusions.
 However, by her reports, she spent the majority of that time in a stasis like coma or sleep, and has less than 50,000 years of actual waking time to her name. She is almost always found reading or trying to do so.
Robin is the longest standing Fate, being the oracle of the Present, she is the one who gave Sam the first prophetic reading that she was Echidna although she has no memory of this. She can see all that goes on in the present around people she's remotely close to or linked with. She can read the minds and transfer memories of sleeping people. In addition, she possesses great wisdom, and acts as an advisor and voice of reason to those who know her, even her "sister" Fubuki, values her input, despite their age gap. She has read, reportedly, every book she's ever seen, and fondly remembers the Library of Alexandria. Due to her reading, she possesses a great understanding of magic despite not using it.
Fubuki is the oldest active character in history, being a just a thousand years older than Robin, who she considers her sister, but unlike Robin, she has been awake for basically the entire time, barring one Ice Age. She leads the House of Esper and the vampires within it and also acts as the world leader of Italy. She has lived in Italy for several centuries and slowly built up an esteemed reputation with the Vatican Church, particularly with the new Pope, who is more empathetic towards Vampires.
An original Nephilem turned Vampire and then returned to Nephilem, Fubuki possesses indescribable depths of knowledge regarding magic, history, and culture. She possesses frighteningly powerful Telekinesis, able to manipulate kinetic energy at a level of precision out of reach for most actual mages, and she kept this power even as a vampire. She can leech kinetic energy from objects to cool them down, but does so at a rate that shatters most material. She can reverse this to heat the world around her. She rarely uses her ability for things other than typical telekinesis.
Despite the terrifying power Fubiki has, to freeze lakes, trigger volcanoes, and reportedly shatter a continent, when people in the know speak of true overwhelming power. They all think of Ares, as the founder of the House of Ares he is where their powers descend from. Reportedly, he is retired out of sheer boredom due to being unable to enjoy fighting in the modern era of ranged combat.
The powers that his house possess are all watered down versions of his power. Which is a form of Kinetic manipulation pushed to an extreme that borders on reality-warping. When some of the greatest members of his house tap into their Ares Rage they lose control of themselves, crackle with energy, and emit tangible heatwaves, sometimes even melting or burning nearby objects. Ares sears the life out of countries and simply absorbs energy thrown towards him. Making him effectively unbeatable without the use of magic, and virtually so even with it. Lately he has become an avid gamer due to the possibility of a challenge amongst pro circuits.
An ancient Nephilem from Fubuki's time, known throughout history as Lucifer the Fallen Angel. Currently acting as the mysterious headmaster in charge of The School and playing a powerful role in the UN.
The headmasters powers are vastly unknown, preferring to perform actions from the sidelines and to observe as things unfold. His opinions on histories view of him as the devil are unknow, however Fubuki claims he's one of the better people, and as such, gives him the benefit of the doubt.
Maria is a regular human, albeit a shockingly healthy, in shape, and genetically clean due to various healings from Sam. This is in stark contrast to the rest of her family who, until very recently, have lived in some of the worst states of poverty in the U.S.
Maria possesses no magical abilities and quite possibly no magical talent. She is however a fantastic cook and chef, and frequently makes food for everyone at Sam's house. She teaches Alice about cooking and frequently made projects with her as they grew up, including making a dragon out of fruit. Which Arram then enchanted to fly around.
Sam's older brother Zach spent the majority of his life involved with drug running and vampire hunting, the former used to fund the latter he would have continued on this path had he not ended up in a relationship with the vampire, Penicilen.
Zach and Sam's parents were brutally killed by vampires when they were young children, while Sam went away to various foster homes, Zach ended up in seedier areas. Due to a mixture of luck and skill Zach has been a successful Vampire-Hunter for many years and has his own group of hunters with him. Since evolving back into a Nephilem from his family crypt, he has all the physical attributes of a Nephilem including powerful wings.
Penicilen, or Pen, is roughly 15,000 years old as a vampire, and possesses the unique ability of healing and preventing poisons and diseases, thus the nickname Penicilen. She claims to have been born in what is roughly the icelandic region and is one of the more benevolent and kind vampires.
Penicilen obtained, shortly after the death of her previous husband 400-500 years ago, the ability to heal in addition to curing and preventing diseases. As she has been rather dedicatedly eating animals instead of feeding off people, her healing ability has grown to something bordering resurrection. Having healed people from a fair bit past the brink of death as much as 5 days past their expiration.
The son of Zach and Penicilen, Raphael is an odd one. Despite being fairly reserved and calm, he is easy to tease as he gets flustered easily by people close to him. He is a genius who absorbs knowledge like a sponge. Like his cousin, he matured physically faster than humans, at a rate of roughly 1 year physically per 2 months chronologically.
Raphael has the unique ability to Blink, that is teleport himself, or parts of himself, a distance away. As a young child he frequently had to visit his mother for healing when he improperly detached or blinked away pieces of himself and couldn't reattach them correctly. Now he can blink across countries by taking quick "short" jumps of only a hundred or so odd miles per jump. He can also detach pieces of himself and continue to use them, such as leaving an ear on a wall, and reattach them remotely.


Feature |
Usage |
Basic app |
See the Pen Basic app by Tuan Chau (@tuanchauict) on CodePen. |
if |
See the Pen Una_u-if by Tuan Chau (@tuanchauict) on CodePen. |
for |
See the Pen oomymp by Tuan Chau (@tuanchauict) on CodePen. |
binding |
See the Pen KyJeEw by Tuan Chau (@tuanchauict) on CodePen. |
click |
See the Pen Una-click by Tuan Chau (@tuanchauict) on CodePen. |


{% extends "bootstrap/base.html" %} {% import "bootstrap/wtf.html" as wtf %} {% import "bootstrap/fixes.html" as fixes %} {% import "bootstrap/utils.html" as util %} {% block styles %} {{ super() }} {% endblock %} {% block title %}Reporting{% endblock %} {% block content %}
The history of compilations and uploads provides insight to curation activities.


com.github.dreamhead.moco.monitor
Interfaces
LogFormatter
LogWriter
Classes
AbstractMonitor
CompositeMonitor
DefaultLogFormatter
DefaultRequestHit
FileLogWriter
LogMonitor
QuietMonitor
Slf4jMonitor
StdLogWriter
ThreadSafeMonitor


public class Microphone extends BaseDataProcessor
A Microphone captures audio data from the system's underlying audio input systems. Converts these audio data
into Data objects. When the method startRecording()
is called, a new thread will be created and used to
capture audio, and will stop when stopRecording()
is called. Calling getData()
returns the
captured audio data as Data objects.
This Microphone will attempt to obtain an audio device with the format
specified in the configuration. If such a device with that format cannot be obtained, it will try to obtain a device
with an audio format that has a higher sample rate than the configured sample rate, while the other parameters of the
format (i.e., sample size, endianness, sign, and channel) remain the same. If, again, no such device can be obtained,
it flags an error, and a call startRecording
returns false.
| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
PROP_BIG_ENDIAN
The property specify the endianness of the data.
|
static java.lang.String |
PROP_BITS_PER_SAMPLE
The property for the number of bits per value.
|
static java.lang.String |
PROP_BUFFER_SIZE
The property that specifies the size of the buffer used to store
audio samples recorded from the microphone.
|
static java.lang.String |
PROP_CHANNELS
The property specifying the number of channels.
|
static java.lang.String |
PROP_CLOSE_BETWEEN_UTTERANCES
The property that specifies whether or not the microphone will release the audio between utterances.
|
static java.lang.String |
PROP_KEEP_LAST_AUDIO
The property that specifies whether to keep the audio data of an utterance around until the next utterance
is recorded.
|
static java.lang.String |
PROP_MSEC_PER_READ
The property that specifies the number of milliseconds of audio data to read each time from the underlying
Java Sound audio device.
|
static java.lang.String |
PROP_SAMPLE_RATE
The property for the sample rate of the data.
|
static java.lang.String |
PROP_SELECT_CHANNEL
The property that specifies the channel to use if the audio is stereo
|
static java.lang.String |
PROP_SELECT_MIXER
The property that specifies the mixer to use.
|
static java.lang.String |
PROP_SIGNED
The property specify whether the data is signed.
|
static java.lang.String |
PROP_STEREO_TO_MONO
The property that specifies how to convert stereo audio to mono.
|
logger
| Constructor and Description |
|---|
Microphone() |
Microphone(int sampleRate,
int bitsPerSample,
int channels,
boolean bigEndian,
boolean signed,
boolean closeBetweenUtterances,
int msecPerRead,
boolean keepLastAudio,
java.lang.String stereoToMono,
int selectedChannel,
java.lang.String selectedMixerIndex,
int audioBufferSize) |
| Modifier and Type | Method and Description |
|---|---|
void |
clear()
Clears all cached audio data.
|
javax.sound.sampled.AudioFormat |
getAudioFormat()
Returns the format of the audio recorded by this Microphone.
|
Data |
getData()
Reads and returns the next Data object from this Microphone, return null if there is no more audio data.
|
Utterance |
getUtterance()
Returns the current Utterance.
|
boolean |
hasMoreData()
Returns true if there is more data in the Microphone.
|
void |
initialize()
Constructs a Microphone with the given InputStream.
|
boolean |
isRecording()
Returns true if this Microphone is recording.
|
void |
newProperties(PropertySheet ps)
This method is called when this configurable component needs to be reconfigured.
|
boolean |
startRecording()
Starts recording audio.
|
void |
stopRecording()
Stops recording audio.
|
getPredecessor, setPredecessor
getName, initLogger, toString
@S4Integer(defaultValue=16000) public static final java.lang.String PROP_SAMPLE_RATE
@S4Boolean(defaultValue=true) public static final java.lang.String PROP_CLOSE_BETWEEN_UTTERANCES
@S4Integer(defaultValue=10) public static final java.lang.String PROP_MSEC_PER_READ
@S4Integer(defaultValue=16) public static final java.lang.String PROP_BITS_PER_SAMPLE
@S4Integer(defaultValue=1) public static final java.lang.String PROP_CHANNELS
@S4Boolean(defaultValue=true) public static final java.lang.String PROP_BIG_ENDIAN
@S4Boolean(defaultValue=true) public static final java.lang.String PROP_SIGNED
@S4Boolean(defaultValue=false) public static final java.lang.String PROP_KEEP_LAST_AUDIO
@S4String(defaultValue="average", range={"average","selectChannel"}) public static final java.lang.String PROP_STEREO_TO_MONO
@S4Integer(defaultValue=0) public static final java.lang.String PROP_SELECT_CHANNEL
@S4String(defaultValue="default") public static final java.lang.String PROP_SELECT_MIXER
AudioTool
,
Constant Field Values@S4Integer(defaultValue=6400) public static final java.lang.String PROP_BUFFER_SIZE
public Microphone(int sampleRate, int bitsPerSample, int channels, boolean bigEndian, boolean signed, boolean closeBetweenUtterances, int msecPerRead, boolean keepLastAudio, java.lang.String stereoToMono, int selectedChannel, java.lang.String selectedMixerIndex, int audioBufferSize)
sampleRate
- sample rate of the databitsPerSample
- number of bits per value.channels
- number of channels.bigEndian
- the endianness of the datasigned
- whether the data is signed.closeBetweenUtterances
- whether or not the microphone will release the audio between utterances. On
certain systems (Linux for one), closing and reopening the audio does not work too well. The default is false for
Linux systems, true for othersmsecPerRead
- the number of milliseconds of audio data to read each time from the underlying
Java Sound audio device.keepLastAudio
- whether to keep the audio data of an utterance around until the next utterance
is recorded.stereoToMono
- how to convert stereo audio to mono. Currently, the possible values are
"average", which averages the samples from at each channel, or "selectChannel", which chooses audio only from
that channel. If you choose "selectChannel", you should also specify which channel to use with the
"selectChannel" property.selectedChannel
- the channel to use if the audio is stereoselectedMixerIndex
- the mixer to use. The value can be "default," (which means let the
AudioSystem decide), "last," (which means select the last Mixer supported by the AudioSystem), which appears to
be what is often used for USB headsets, or an integer value which represents the index of the Mixer.Info that is
returned by AudioSystem.getMixerInfo(). To get the list of Mixer.Info objects, run the AudioTool application with
a command line argument of "-dumpMixers".audioBufferSize
- buffer sizepublic Microphone()
public void newProperties(PropertySheet ps) throws PropertyException
Configurable
newProperties
in interface Configurable
newProperties
in class ConfigurableAdapter
ps
- a property sheet holding the new dataPropertyException
- if there is a problem with the properties.public void initialize()
initialize
in interface DataProcessor
initialize
in class BaseDataProcessor
public javax.sound.sampled.AudioFormat getAudioFormat()
public Utterance getUtterance()
public boolean isRecording()
public boolean startRecording()
public void stopRecording()
public void clear()
public Data getData() throws DataProcessingException
startRecording()
and stopRecording()
is cached in an
Utterance object. Calling this method basically returns the next chunk of audio data cached in this Utterance.getData
in interface DataProcessor
getData
in class BaseDataProcessor
null
if none is availableDataProcessingException
- if there is a data processing errorpublic boolean hasMoreData()


Result
Users Distribution in Clusters
Cluster
Cluster Count
{% for key in data3 %}
{{ key[0] }}
{{ key[1] }}
{% endfor %}
Check for any users who has more/less access rights :
Outliers Detected
Recommend access rights to new user :
Entitlement Prediction


You start to panic and ask the bus driver to pull over.  The next thing you know you find yourself back in bed.