xmlbase.3am - Man Page
Provides some basic functionality to gawk-xml.
Synopsis
@include "xmlbase" result = XmlEscape(str) result = XmlEscapeQuote(str) XmlWriteError(message) XmlCheckError()
Description
The xmlbase awk library adds some basic facilities to the gawk-xml extension.
- Automatic error reporting
The xmlbase library contains a rule that automatically invokes XmlCheckError() at ENDFILE.
- XmlEscape(str)
Returns the string argument with the basic XML metacharacters (<, >, &) replaced by their predefined XML escape sequences.
- XmlEscapeQuote(str)
Returns the string argument with all the XML metacharacters (<, >, &, ", ') replaced by their predefined XML escape sequences.
- XmlWriteError(message)
Prints a formatted diagnostic message showing FILENAME, XMLROW, XMLCOL, XMLLEN and the string argument.
- XmlCheckError()
If either XMLERROR or ERRNO have a non-null value, invokes XmlWriteError() on it. XMLERROR takes precedence over ERRNO. If ERRNO is used then it is cleared, to avoid duplicated error reports.
Notes
The xmlbase library automatically loads the xml gawk extension.
Bugs
The error reporting facility may not suit everybody.
Author
Manuel Collado, m-collado@users.sourceforge.net.
See Also
XML Processing With gawk, xmlcopy(3am), xmltree(3am), xmlsimple(3am), xmlwrite(3am).
Copying Permissions
Copyright (C) 2017, Free Software Foundation, Inc.
Permission is granted to make and distribute verbatim copies of this manual page provided the copyright notice and this permission notice are preserved on all copies.
Permission is granted to copy and distribute modified versions of this manual page under the conditions for verbatim copying, provided that the entire resulting derived work is distributed under the terms of a permission notice identical to this one.
Permission is granted to copy and distribute translations of this manual page into another language, under the above conditions for modified versions, except that this permission notice may be stated in a translation approved by the Foundation.