/usr/include/sbml/xml/XMLNamespaces.h is in libsbml5-dev 5.10.0+dfsg-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 | /**
* @file XMLNamespaces.h
* @brief A list of XMLNamespace declarations (URI/prefix pairs)
* @author Ben Bornstein
*
* <!--------------------------------------------------------------------------
* This file is part of libSBML. Please visit http://sbml.org for more
* information about SBML, and the latest version of libSBML.
*
* Copyright (C) 2013-2014 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
* 3. University of Heidelberg, Heidelberg, Germany
*
* Copyright (C) 2009-2013 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. EMBL European Bioinformatics Institute (EMBL-EBI), Hinxton, UK
*
* Copyright (C) 2006-2008 by the California Institute of Technology,
* Pasadena, CA, USA
*
* Copyright (C) 2002-2005 jointly by the following organizations:
* 1. California Institute of Technology, Pasadena, CA, USA
* 2. Japan Science and Technology Agency, Japan
*
* This library is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published by
* the Free Software Foundation. A copy of the license agreement is provided
* in the file named "LICENSE.txt" included with this software distribution
* and also available online as http://sbml.org/software/libsbml/license.html
* ------------------------------------------------------------------------ -->
*
* @class XMLNamespaces
* @sbmlbrief{core} Representation of XML Namespaces.
*
* @htmlinclude not-sbml-warning.html
*
* This class serves to organize functionality for tracking XML namespaces
* in a document or data stream. The namespace declarations are stored as
* a list of pairs of XML namespace URIs and prefix strings. These
* correspond to the parts of a namespace declaration on an XML element.
* For example, in the following XML fragment,
* @verbatim
<annotation>
<mysim:nodecolors xmlns:mysim="urn:lsid:mysim.org"
mysim:bgcolor="green" mysim:fgcolor="white"/>
</annotation>
@endverbatim
* there is one namespace declaration. Its URI is
* <code>urn:lsid:mysim.org</code> and its prefix is <code>mysim</code>.
* This pair could be stored as one item in an XMLNamespaces list.
*
* XMLNamespaces provides various methods for manipulating the list of
* prefix-URI pairs. Individual namespaces stored in a given XMLNamespace
* object instance can be retrieved based on their index using
* XMLNamespaces::getPrefix(int index), or by their characteristics such as
* their URI or position in the list.
*/
#ifndef XMLNamespaces_h
#define XMLNamespaces_h
#include <sbml/xml/XMLExtern.h>
#include <sbml/common/sbmlfwd.h>
#include <sbml/common/operationReturnValues.h>
#ifdef __cplusplus
#include <string>
#include <vector>
LIBSBML_CPP_NAMESPACE_BEGIN
/** @cond doxygenLibsbmlInternal */
class XMLOutputStream;
/** @endcond */
class LIBLAX_EXTERN XMLNamespaces
{
public:
/**
* Creates a new empty list of XML namespace declarations.
*/
XMLNamespaces ();
/**
* Destroys this list of XML namespace declarations.
*/
virtual ~XMLNamespaces ();
/**
* Copy constructor; creates a copy of this XMLNamespaces list.
*
* @param orig the XMLNamespaces object to copy
*
* @throws @if python ValueError @else XMLConstructorException @endif@~
* Thrown if the argument @p orig is @c NULL.
*/
XMLNamespaces(const XMLNamespaces& orig);
/**
* Assignment operator for XMLNamespaces.
*
* @param rhs The XMLNamespaces object whose values are used as the basis
* of the assignment.
*
* @throws @if python ValueError @else XMLConstructorException @endif@~
* Thrown if the argument @p rhs is @c NULL.
*/
XMLNamespaces& operator=(const XMLNamespaces& rhs);
/**
* Creates and returns a deep copy of this XMLNamespaces list.
*
* @return a (deep) copy of this XMLNamespaces list.
*/
XMLNamespaces* clone () const;
/**
* Appends an XML namespace prefix and URI pair to this list of namespace
* declarations.
*
* An XMLNamespaces object stores a list of pairs of namespaces and their
* prefixes. If there is an XML namespace with the given @p uri prefix
* in this list, then its corresponding URI will be overwritten by the
* new @p uri unless the uri represents the core sbml namespace.
* Calling programs could use one of the other XMLNamespaces
* methods, such as
* XMLNamespaces::hasPrefix(@if java String@endif) and
* XMLNamespaces::hasURI(@if java String@endif) to
* inquire whether a given prefix and/or URI
* is already present in this XMLNamespaces object.
* If the @p uri represents the sbml namespaces then it will not be
* overwritten, as this has potentially serious consequences. If it
* is necessary to replace the sbml namespace the namespace should be removed
* prior to adding the new namespace.
*
* @param uri a string, the uri for the namespace
* @param prefix a string, the prefix for the namespace
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_FAILED LIBSBML_OPERATION_FAILED @endlink
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*/
int add (const std::string& uri, const std::string& prefix = "");
/**
* Removes an XML Namespace stored in the given position of this list.
*
* @param index an integer, position of the namespace to remove.
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
*/
int remove (int index);
/**
* Removes an XML Namespace with the given prefix.
*
* @param prefix a string, prefix of the required namespace.
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
*
* @see remove(int index)
*/
int remove (const std::string& prefix);
/**
* Clears (deletes) all XML namespace declarations in this XMLNamespaces
* object.
*
* @return integer value indicating success/failure of the
* function. The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_FAILED LIBSBML_OPERATION_FAILED@endlink
*
* @see remove(int index)
*/
int clear ();
/**
* Look up the index of an XML namespace declaration by URI.
*
* An XMLNamespaces object stores a list of pairs of namespaces and their
* prefixes. If this XMLNamespaces object contains a pair with the given
* URI @p uri, this method returns its index in the list.
*
* @param uri a string, the URI of the sought-after namespace.
*
* @return the index of the given declaration, or <code>-1</code> if not
* present.
*/
int getIndex (const std::string uri) const;
/**
* Tests whether the given uri is contained in this set of namespaces.
*
*/
bool containsUri(const std::string uri) const;
/**
* Look up the index of an XML namespace declaration by prefix.
*
* An XMLNamespaces object stores a list of pairs of namespaces and their
* prefixes. If this XMLNamespaces object contains a pair with the given
* prefix @p prefix, this method returns its index in the list.
*
* @param prefix a string, the prefix string of the sought-after
* namespace
*
* @return the index of the given declaration, or <code>-1</code> if not
* present.
*/
int getIndexByPrefix (const std::string prefix) const;
/**
* Returns the total number of URI-and-prefix pairs stored in this
* particular XMLNamespaces instance.
*
* @return the number of namespaces in this list.
*/
int getLength () const;
/**
* Returns the total number of URI-and-prefix pairs stored in this
* particular XMLNamespaces instance.
*
* @return the number of namespaces in this list.
*
* This function is an alias for getLength introduced for consistency
* with other XML classes.
*/
int getNumNamespaces () const;
/**
* Look up the prefix of an XML namespace declaration by its position.
*
* An XMLNamespaces object stores a list of pairs of namespaces and their
* prefixes. This method returns the prefix of the <code>n</code>th
* element in that list (if it exists). Callers should use
* XMLAttributes::getLength() first to find out how many namespaces are
* stored in the list.
*
* @param index an integer, position of the sought-after prefix
*
* @return the prefix of an XML namespace declaration in this list (by
* position), or an empty string if the @p index is out of range
*
* @see getLength()
*/
std::string getPrefix (int index) const;
/**
* Look up the prefix of an XML namespace declaration by its URI.
*
* An XMLNamespaces object stores a list of pairs of namespaces and their
* prefixes. This method returns the prefix for a pair that has the
* given @p uri.
*
* @param uri a string, the URI of the prefix being sought
*
* @return the prefix of an XML namespace declaration given its URI, or
* an empty string if no such @p uri exists in this XMLNamespaces object
*/
std::string getPrefix (const std::string& uri) const;
/**
* Look up the URI of an XML namespace declaration by its position.
*
* An XMLNamespaces object stores a list of pairs of namespaces and their
* prefixes. This method returns the URI of the <code>n</code>th element
* in that list (if it exists). Callers should use
* XMLAttributes::getLength() first to find out how many namespaces are
* stored in the list.
*
* @param index an integer, position of the required URI.
*
* @return the URI of an XML namespace declaration in this list (by
* position), or an empty string if the @p index is out of range.
*
* @see getLength()
*/
std::string getURI (int index) const;
/**
* Look up the URI of an XML namespace declaration by its prefix.
*
* An XMLNamespaces object stores a list of pairs of namespaces and their
* prefixes. This method returns the namespace URI for a pair that has
* the given @p prefix.
*
* @param prefix a string, the prefix of the required URI
*
* @return the URI of an XML namespace declaration having the given @p
* prefix, or an empty string if no such prefix-and-URI pair exists
* in this XMLNamespaces object
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*
* @see getURI()
*/
std::string getURI (const std::string& prefix = "") const;
/**
* Predicate returning @c true or @c false depending on whether this
* XMLNamespaces list is empty.
*
* @return @c true if this XMLNamespaces list is empty, @c false otherwise.
*/
bool isEmpty () const;
/**
* Predicate returning @c true or @c false depending on whether an XML
* Namespace with the given URI is contained in this XMLNamespaces list.
*
* @param uri a string, the uri for the namespace
*
* @return @c true if an XML Namespace with the given URI is contained in
* this XMLNamespaces list, @c false otherwise.
*/
bool hasURI(const std::string& uri) const;
/**
* Predicate returning @c true or @c false depending on whether an XML
* Namespace with the given prefix is contained in this XMLNamespaces
* list.
*
* @param prefix a string, the prefix for the namespace
*
* @return @c true if an XML Namespace with the given URI is contained in
* this XMLNamespaces list, @c false otherwise.
*/
bool hasPrefix(const std::string& prefix) const;
/**
* Predicate returning @c true or @c false depending on whether an XML
* Namespace with the given URI and prefix pair is contained in this
* XMLNamespaces list.
*
* @param uri a string, the URI for the namespace
* @param prefix a string, the prefix for the namespace
*
* @return @c true if an XML Namespace with the given uri/prefix pair is
* contained in this XMLNamespaces list, @c false otherwise.
*/
bool hasNS(const std::string& uri, const std::string& prefix) const;
#ifndef SWIG
/** @cond doxygenLibsbmlInternal */
/**
* Writes this XMLNamespaces list to stream.
*
* @param stream XMLOutputStream, stream to which this XMLNamespaces
* list is to be written.
*/
void write (XMLOutputStream& stream) const;
/**
* Inserts this XMLNamespaces list into stream.
*
* @param stream XMLOutputStream, stream to which the XMLNamespaces
* list is to be written.
* @param namespaces XMLNamespaces, namespaces to be written to stream.
*
* @return the stream with the namespaces inserted.
*/
LIBLAX_EXTERN
friend XMLOutputStream&
operator<< (XMLOutputStream& stream, const XMLNamespaces& namespaces);
/** @endcond */
#endif /* !SWIG */
/** @cond doxygenLibsbmlInternal */
friend class SBase;
/** @endcond */
protected:
/** @cond doxygenLibsbmlInternal */
/**
* Removes the default XML namespace.
*/
void removeDefault ();
bool containIdenticalSetNS(XMLNamespaces* rhs);
typedef std::pair<std::string, std::string> PrefixURIPair;
std::vector<PrefixURIPair> mNamespaces;
/** @endcond */
};
LIBSBML_CPP_NAMESPACE_END
#endif /* __cplusplus */
#ifndef SWIG
LIBSBML_CPP_NAMESPACE_BEGIN
BEGIN_C_DECLS
/**
* Creates a new empty XMLNamespaces_t structure.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
XMLNamespaces_t *
XMLNamespaces_create (void);
/**
* Frees the given XMLNamespaces_t structure.
*
* @param ns XMLNamespaces structure to be freed.
**
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
void
XMLNamespaces_free (XMLNamespaces_t *ns);
/**
* Creates a deep copy of the given XMLNamespaces_t structure
*
* @param ns the XMLNamespaces_t structure to be copied
*
* @return a (deep) copy of the given XMLNamespaces_t structure.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
XMLNamespaces_t *
XMLNamespaces_clone (const XMLNamespaces_t* ns);
/**
* Appends an XML namespace prefix/URI pair to this XMLNamespaces_t
* structure.
*
* @param ns the XMLNamespaces_t structure.
* @param uri a string, the uri for the namespace.
* @param prefix a string, the prefix for the namespace.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_FAILED LIBSBML_OPERATION_FAILED @endlink
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_add (XMLNamespaces_t *ns,
const char *uri, const char *prefix);
/**
* Removes an XML Namespace stored in the given position of this list.
*
* @param ns XMLNamespaces structure.
* @param index an integer, position of the removed namespace.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_remove (XMLNamespaces_t *ns, int index);
/**
* Removes an XML Namespace with the given @p prefix.
*
* @param ns XMLNamespaces structure.
* @param prefix a string, prefix of the required namespace.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_INDEX_EXCEEDS_SIZE LIBSBML_INDEX_EXCEEDS_SIZE @endlink
* @li @link OperationReturnValues_t#LIBSBML_INVALID_OBJECT LIBSBML_INVALID_OBJECT @endlink
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_removeByPrefix (XMLNamespaces_t *ns, const char* prefix);
/**
* Clears this XMLNamespaces_t structure.
*
* @param ns XMLNamespaces structure.
*
* @return integer value indicating success/failure of the
* function. @if clike The value is drawn from the
* enumeration #OperationReturnValues_t. @endif@~ The possible values
* returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS @endlink
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_FAILED LIBSBML_OPERATION_FAILED @endlink
**
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_clear (XMLNamespaces_t *ns);
/**
* Lookup the index of an XML namespace declaration by URI.
*
* @param ns the XMLNamespaces_t structure
* @param uri a string, uri of the required namespace.
*
* @return the index of the given declaration, or -1 if not present.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_getIndex (const XMLNamespaces_t *ns, const char *uri);
/**
* Look up the index of an XML namespace declaration by Prefix.
*
* @param ns the XMLNamespaces_t structure
* @param prefix a string, prefix of the required namespace.
*
* @return the index of the given declaration, or -1 if not present.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int XMLNamespaces_getIndexByPrefix (const XMLNamespaces_t *ns, const char* prefix);
/**
* Returns the total number of URI-and-prefix pairs stored in this
* particular XMLNamespaces instance.
*
* @param ns the XMLNamespaces_t structure
*
* @return the number of namespaces in this list.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_getLength (const XMLNamespaces_t *ns);
/**
* Returns the total number of URI-and-prefix pairs stored in this
* particular XMLNamespaces instance.
*
* This function is an alias for getLength introduced for consistency
* with other XML classes.
*
* @param ns the XMLNamespaces_t structure
*
* @return the number of namespaces in this list.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_getNumNamespaces (const XMLNamespaces_t *ns);
/**
* Look up the prefix of an XML namespace declaration by its position.
*
* An XMLNamespaces structure stores a list of pairs of namespaces and their
* prefixes. This method returns the prefix of the <code>n</code>th
* element in that list (if it exists). Callers should use
* XMLAttributes_getLength() first to find out how many namespaces are
* stored in the list.
*
* @param ns the XMLNamespaces_t structure
* @param index an integer, position of the sought-after prefix
*
* @return the prefix of an XML namespace declaration in this list (by
* position), or an empty string if the @p index is out of range
*
* @see XMLNamespaces_getLength()
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
char *
XMLNamespaces_getPrefix (const XMLNamespaces_t *ns, int index);
/**
* Look up the prefix of an XML namespace declaration by its URI.
*
* An XMLNamespaces structure stores a list of pairs of namespaces and their
* prefixes. This method returns the prefix for a pair that has the
* given @p uri.
*
* @param ns the XMLNamespaces_t structure
* @param uri a string, the URI of the prefix being sought
*
* @return the prefix of an XML namespace declaration given its URI, or
* an empty string if no such @p uri exists in this XMLNamespaces_t structure
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
char *
XMLNamespaces_getPrefixByURI (const XMLNamespaces_t *ns, const char *uri);
/**
* Look up the URI of an XML namespace declaration by its position.
*
* An XMLNamespaces structure stores a list of pairs of namespaces and their
* prefixes. This method returns the URI of the <code>n</code>th element
* in that list (if it exists). Callers should use
* XMLAttributes::getLength() first to find out how many namespaces are
* stored in the list.
*
* @param ns the XMLNamespaces_t structure
* @param index an integer, position of the required URI.
*
* @return the URI of an XML namespace declaration in this list (by
* position), or an empty string if the @p index is out of range.
*
* @see XMLNamespaces_getLength()
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
char *
XMLNamespaces_getURI (const XMLNamespaces_t *ns, int index);
/**
* Look up the URI of an XML namespace declaration by its prefix.
*
* An XMLNamespaces object stores a list of pairs of namespaces and their
* prefixes. This method returns the namespace URI for a pair that has
* the given @p prefix.
*
* @param ns the XMLNamespaces_t structure
* @param prefix a string, the prefix of the required URI
*
* @return the URI of an XML namespace declaration having the given @p
* prefix, or an empty string if no such prefix-and-URI pair exists
* in this XMLNamespaces_t object
*
* @if notcpp @htmlinclude warn-default-args-in-docs.html @endif@~
*
* @see getURI()
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
char *
XMLNamespaces_getURIByPrefix (const XMLNamespaces_t *ns, const char *prefix);
/**
* Predicate returning @c true or @c false depending on whether
* this XMLNamespaces_t list is empty.
*
* @return @c true if this XMLNamespaces_t list is empty, @c false otherwise.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_isEmpty (const XMLNamespaces_t *ns);
/**
* Predicate returning @c true or @c false depending on whether
* an XML Namespace with the given URI is contained in this XMLNamespaces_t list.
*
* @return @c true if an XML Namespace with the given URI is contained in this
* XMLNamespaces list, @c false otherwise.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_hasURI(const XMLNamespaces_t *ns, const char* uri);
/**
* Predicate returning @c true or @c false depending on whether
* an XML Namespace the given @p prefix is contained in this XMLNamespaces_t list.
*
* @return @c true if an XML Namespace with the given URI is contained in this
* XMLNamespaces list, @c false otherwise.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_hasPrefix(const XMLNamespaces_t *ns, const char* prefix);
/**
* Predicate returning @c true or @c false depending on whether
* an XML Namespace with the given URI is contained in this XMLNamespaces_t list.
*
* @return @c true if an XML Namespace with the given uri/prefix pair is contained
* in this XMLNamespaces_t list, @c false otherwise.
*
* @memberof XMLNamespaces_t
*/
LIBLAX_EXTERN
int
XMLNamespaces_hasNS(const XMLNamespaces_t *ns, const char* uri, const char* prefix);
END_C_DECLS
LIBSBML_CPP_NAMESPACE_END
#endif /* !SWIG */
#endif /* XMLNamespaces_h */
|