lib/libxml2
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/libxml2.git synced 2025-10-21 14:53:44 +03:00
Code Activity

Added some comments for the struct fields.

Browse Source 
* include/libxml/schemasInternals.h: Added some comments for the
  struct fields.
This commit is contained in:
Kasimier T. Buchcik
2005-09-14 17:53:43 +00:00
parent 4d73bb323a
commit ef3d07d809
2 changed files with 80 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
ChangeLog
View File

@@ -1,3 +1,8 @@
Wed Sep 14 19:52:18 CEST 2005 Kasimier Buchcik <libxml2-cvs@cazic.net>
* include/libxml/schemasInternals.h: Added some comments for the
struct fields.
Wed Sep 14 13:24:27 HKT 2005 William Brack <wbrack@mmm.com.hk> Wed Sep 14 13:24:27 HKT 2005 William Brack <wbrack@mmm.com.hk>
* uri.c: fixed problem when xmlBuildRelativeURI was given a * uri.c: fixed problem when xmlBuildRelativeURI was given a

126
include/libxml/schemasInternals.h
View File

@@ -124,7 +124,7 @@ typedef enum {
XML_SCHEMA_CONTENT_ELEMENTS, XML_SCHEMA_CONTENT_ELEMENTS,
XML_SCHEMA_CONTENT_MIXED, XML_SCHEMA_CONTENT_MIXED,
XML_SCHEMA_CONTENT_SIMPLE, XML_SCHEMA_CONTENT_SIMPLE,
XML_SCHEMA_CONTENT_MIXED_OR_ELEMENTS, /* obsolete, not used */ XML_SCHEMA_CONTENT_MIXED_OR_ELEMENTS, /* Obsolete */
XML_SCHEMA_CONTENT_BASIC, XML_SCHEMA_CONTENT_BASIC,
XML_SCHEMA_CONTENT_ANY XML_SCHEMA_CONTENT_ANY
} xmlSchemaContentType; } xmlSchemaContentType;
@@ -242,8 +242,8 @@ struct _xmlSchemaAnnot {
typedef struct _xmlSchemaAttribute xmlSchemaAttribute; typedef struct _xmlSchemaAttribute xmlSchemaAttribute;
typedef xmlSchemaAttribute *xmlSchemaAttributePtr; typedef xmlSchemaAttribute *xmlSchemaAttributePtr;
struct _xmlSchemaAttribute { struct _xmlSchemaAttribute {
xmlSchemaTypeType type; /* The kind of type */ xmlSchemaTypeType type;
struct _xmlSchemaAttribute *next;/* the next attribute if in a group ... */ struct _xmlSchemaAttribute *next; /* the next attribute ... */
const xmlChar *name; /* name of the declaration or empty if particle */ const xmlChar *name; /* name of the declaration or empty if particle */
const xmlChar *id; const xmlChar *id;
const xmlChar *ref; /* the local name of the attribute decl. if a particle */ const xmlChar *ref; /* the local name of the attribute decl. if a particle */
@@ -252,21 +252,22 @@ struct _xmlSchemaAttribute {
const xmlChar *typeNs; /* the ns URI of the type definition */ const xmlChar *typeNs; /* the ns URI of the type definition */
xmlSchemaAnnotPtr annot; xmlSchemaAnnotPtr annot;
xmlSchemaTypePtr base; /* obsolete, not used */ xmlSchemaTypePtr base; /* Obsolete, */
int occurs; int occurs;
const xmlChar *defValue; const xmlChar *defValue; /* The original value of the value constraint */
xmlSchemaTypePtr subtypes; /* the type definition */ xmlSchemaTypePtr subtypes; /* the type definition */
xmlNodePtr node; xmlNodePtr node;
const xmlChar *targetNamespace; const xmlChar *targetNamespace;
int flags; int flags;
const xmlChar *refPrefix; const xmlChar *refPrefix; /* Obsolete */
xmlSchemaValPtr defVal; xmlSchemaValPtr defVal; /* The compiled value constraint */
xmlSchemaAttributePtr refDecl; xmlSchemaAttributePtr refDecl;
}; };
/** /**
* xmlSchemaAttributeLink: * xmlSchemaAttributeLink:
* Used to build a list of attribute uses on complexType definitions. * Used to build a list of attribute uses on complexType definitions.
* TODO: Extend this to work as an "attribute use".
*/ */
typedef struct _xmlSchemaAttributeLink xmlSchemaAttributeLink; typedef struct _xmlSchemaAttributeLink xmlSchemaAttributeLink;
typedef xmlSchemaAttributeLink *xmlSchemaAttributeLinkPtr; typedef xmlSchemaAttributeLink *xmlSchemaAttributeLinkPtr;
@@ -304,8 +305,8 @@ struct _xmlSchemaWildcard {
const xmlChar *id; const xmlChar *id;
xmlSchemaAnnotPtr annot; xmlSchemaAnnotPtr annot;
xmlNodePtr node; xmlNodePtr node;
int minOccurs; int minOccurs; /* Obsolete; this goes into particles */
int maxOccurs; int maxOccurs; /* Obsolete; this goes into particles */
int processContents; int processContents;
int any; /* Indicates if the ns constraint is of ##any */ int any; /* Indicates if the ns constraint is of ##any */
xmlSchemaWildcardNsPtr nsSet; /* The list of allowed namespaces */ xmlSchemaWildcardNsPtr nsSet; /* The list of allowed namespaces */
@@ -332,6 +333,13 @@ struct _xmlSchemaWildcard {
*/ */
#define XML_SCHEMAS_ATTRGROUP_MARKED 1 << 2 #define XML_SCHEMAS_ATTRGROUP_MARKED 1 << 2
/**
* XML_SCHEMAS_ATTRGROUP_REDEFINED:
*
* The attr group was redefined.
*/
#define XML_SCHEMAS_ATTRGROUP_REDEFINED 1 << 3
/** /**
* An attribute group definition. * An attribute group definition.
* *
@@ -353,10 +361,9 @@ struct _xmlSchemaAttributeGroup {
xmlNodePtr node; xmlNodePtr node;
int flags; int flags;
xmlSchemaWildcardPtr attributeWildcard; xmlSchemaWildcardPtr attributeWildcard;
const xmlChar *refPrefix; const xmlChar *refPrefix; /* Obsolete */
xmlSchemaAttributeGroupPtr refItem; /* The referenced attribute group */ xmlSchemaAttributeGroupPtr refItem; /* The referenced attribute group */
const xmlChar *targetNamespace; const xmlChar *targetNamespace;
/* xmlSchemaAttributeGroupPtr redef;*/ /* Redefinitions */
}; };
/** /**
@@ -368,7 +375,7 @@ typedef struct _xmlSchemaTypeLink xmlSchemaTypeLink;
typedef xmlSchemaTypeLink *xmlSchemaTypeLinkPtr; typedef xmlSchemaTypeLink *xmlSchemaTypeLinkPtr;
struct _xmlSchemaTypeLink { struct _xmlSchemaTypeLink {
struct _xmlSchemaTypeLink *next;/* the next type link ... */ struct _xmlSchemaTypeLink *next;/* the next type link ... */
xmlSchemaTypePtr type;/* the linked type*/ xmlSchemaTypePtr type;/* the linked type */
}; };
/** /**
@@ -417,6 +424,9 @@ struct _xmlSchemaFacetLink {
* XML_SCHEMAS_TYPE_VARIETY_ABSENT: * XML_SCHEMAS_TYPE_VARIETY_ABSENT:
* *
* the simpleType has a variety of "absent". * the simpleType has a variety of "absent".
* TODO: Actually not necessary :-/, since if
* none of the variety flags occur then it's
* automatically absent.
*/ */
#define XML_SCHEMAS_TYPE_VARIETY_ABSENT 1 << 5 #define XML_SCHEMAS_TYPE_VARIETY_ABSENT 1 << 5
/** /**
@@ -560,6 +570,19 @@ struct _xmlSchemaFacetLink {
*/ */
#define XML_SCHEMAS_TYPE_FIXUP_1 1 << 29 #define XML_SCHEMAS_TYPE_FIXUP_1 1 << 29
/**
* XML_SCHEMAS_TYPE_REDEFINED:
*
* The type was redefined.
*/
#define XML_SCHEMAS_TYPE_REDEFINED 1 << 30
/**
* XML_SCHEMAS_TYPE_REDEFINING:
*
* The type redefines an other type.
*/
/* #define XML_SCHEMAS_TYPE_REDEFINING 1 << 31 */
/** /**
* _xmlSchemaType: * _xmlSchemaType:
* *
@@ -569,30 +592,30 @@ struct _xmlSchemaType {
xmlSchemaTypeType type; /* The kind of type */ xmlSchemaTypeType type; /* The kind of type */
struct _xmlSchemaType *next;/* the next type if in a sequence ... */ struct _xmlSchemaType *next;/* the next type if in a sequence ... */
const xmlChar *name; const xmlChar *name;
const xmlChar *id; const xmlChar *id; /* Obsolete; the ID is not part of the component */
const xmlChar *ref; const xmlChar *ref; /* TODO: Obsolete ? */
const xmlChar *refNs; const xmlChar *refNs; /* TODO: Obsolete ? */
xmlSchemaAnnotPtr annot; xmlSchemaAnnotPtr annot;
xmlSchemaTypePtr subtypes; xmlSchemaTypePtr subtypes;
xmlSchemaAttributePtr attributes; xmlSchemaAttributePtr attributes; /* Explicitely declared attributes or refs */
xmlNodePtr node; xmlNodePtr node;
int minOccurs; int minOccurs; /* Obsolete; this goes into particles */
int maxOccurs; int maxOccurs; /* Obsolete; this goes into particles */
int flags; int flags;
xmlSchemaContentType contentType; xmlSchemaContentType contentType;
const xmlChar *base; const xmlChar *base; /* Base type's local name */
const xmlChar *baseNs; const xmlChar *baseNs; /* Base type's target namespace */
xmlSchemaTypePtr baseType; xmlSchemaTypePtr baseType; /* The base type component */
xmlSchemaFacetPtr facets; xmlSchemaFacetPtr facets; /* Local facets */
struct _xmlSchemaType *redef;/* possible redefinitions for the type */ struct _xmlSchemaType *redef; /* Obsolete */
int recurse; int recurse; /* Obsolete */
xmlSchemaAttributeLinkPtr attributeUses; xmlSchemaAttributeLinkPtr attributeUses; /* Attribute uses (incl. inherited) */
xmlSchemaWildcardPtr attributeWildcard; xmlSchemaWildcardPtr attributeWildcard;
int builtInType; int builtInType;
xmlSchemaTypeLinkPtr memberTypes; xmlSchemaTypeLinkPtr memberTypes;
xmlSchemaFacetLinkPtr facetSet; xmlSchemaFacetLinkPtr facetSet; /* All facets (incl. inherited) */
const xmlChar *refPrefix; const xmlChar *refPrefix; /* Obsolete */
xmlSchemaTypePtr contentTypeDef; xmlSchemaTypePtr contentTypeDef;
xmlRegexpPtr contModel; xmlRegexpPtr contModel;
const xmlChar *targetNamespace; const xmlChar *targetNamespace;
@@ -727,18 +750,18 @@ struct _xmlSchemaType {
typedef struct _xmlSchemaElement xmlSchemaElement; typedef struct _xmlSchemaElement xmlSchemaElement;
typedef xmlSchemaElement *xmlSchemaElementPtr; typedef xmlSchemaElement *xmlSchemaElementPtr;
struct _xmlSchemaElement { struct _xmlSchemaElement {
xmlSchemaTypeType type; /* The kind of type */ xmlSchemaTypeType type; /* The kind of type */
struct _xmlSchemaType *next;/* the next type if in a sequence ... */ struct _xmlSchemaType *next; /* Not used? */
const xmlChar *name; const xmlChar *name;
const xmlChar *id; const xmlChar *id; /* Obsolete */
const xmlChar *ref; /* the local name of the element declaration if a particle */ const xmlChar *ref; /* Obsolete */
const xmlChar *refNs; /* the ns URI of the element declaration if a particle */ const xmlChar *refNs; /* Obsolete */
xmlSchemaAnnotPtr annot; xmlSchemaAnnotPtr annot;
xmlSchemaTypePtr subtypes; /* the type definition */ xmlSchemaTypePtr subtypes; /* the type definition */
xmlSchemaAttributePtr attributes; xmlSchemaAttributePtr attributes;
xmlNodePtr node; xmlNodePtr node;
int minOccurs; int minOccurs; /* Obsolete; this goes into particles. */
int maxOccurs; int maxOccurs; /* Obsolete; this goes into particles. */
int flags; int flags;
const xmlChar *targetNamespace; const xmlChar *targetNamespace;
@@ -747,13 +770,14 @@ struct _xmlSchemaElement {
const xmlChar *substGroup; const xmlChar *substGroup;
const xmlChar *substGroupNs; const xmlChar *substGroupNs;
const xmlChar *scope; const xmlChar *scope;
const xmlChar *value; const xmlChar *value; /* The original value of the value constraint. */
struct _xmlSchemaElement *refDecl; /* This will now be used for the substitution group affiliation */ struct _xmlSchemaElement *refDecl; /* This will now be used for the
xmlRegexpPtr contModel; substitution group affiliation */
xmlRegexpPtr contModel; /* Obsolete for WXS, maybe used for RelaxNG */
xmlSchemaContentType contentType; xmlSchemaContentType contentType;
const xmlChar *refPrefix; const xmlChar *refPrefix; /* Obsolete */
xmlSchemaValPtr defVal; xmlSchemaValPtr defVal; /* The compiled value contraint. */
void *idcs; void *idcs; /* The identity-constraint defs */
}; };
/* /*
@@ -786,14 +810,14 @@ struct _xmlSchemaElement {
struct _xmlSchemaFacet { struct _xmlSchemaFacet {
xmlSchemaTypeType type; /* The kind of type */ xmlSchemaTypeType type; /* The kind of type */
struct _xmlSchemaFacet *next;/* the next type if in a sequence ... */ struct _xmlSchemaFacet *next;/* the next type if in a sequence ... */
const xmlChar *value; const xmlChar *value; /* The original value */
const xmlChar *id; const xmlChar *id; /* Obsolete */
xmlSchemaAnnotPtr annot; xmlSchemaAnnotPtr annot;
xmlNodePtr node; xmlNodePtr node;
int fixed; int fixed; /* XML_SCHEMAS_FACET_PRESERVE, etc. */
int whitespace; int whitespace;
xmlSchemaValPtr val; xmlSchemaValPtr val; /* The compiled value */
xmlRegexpPtr regexp; xmlRegexpPtr regexp; /* The regex for patterns */
}; };
/** /**
@@ -810,7 +834,7 @@ struct _xmlSchemaNotation {
}; };
/* /*
* Actually all those flags used for the schema should sit * TODO: Actually all those flags used for the schema should sit
* on the schema parser context, since they are used only * on the schema parser context, since they are used only
* during parsing an XML schema document, and not available * during parsing an XML schema document, and not available
* on the component level as per spec. * on the component level as per spec.
@@ -884,10 +908,10 @@ struct _xmlSchemaNotation {
* A Schemas definition * A Schemas definition
*/ */
struct _xmlSchema { struct _xmlSchema {
const xmlChar *name; /* schema name */ const xmlChar *name; /* schema name */
const xmlChar *targetNamespace; /* the target namespace */ const xmlChar *targetNamespace; /* the target namespace */
const xmlChar *version; const xmlChar *version;
const xmlChar *id; const xmlChar *id; /* Obsolete */
xmlDocPtr doc; xmlDocPtr doc;
xmlSchemaAnnotPtr annot; xmlSchemaAnnotPtr annot;
int flags; int flags;
@@ -906,8 +930,8 @@ struct _xmlSchema {
void *includes; /* the includes, this is opaque for now */ void *includes; /* the includes, this is opaque for now */
int preserve; /* whether to free the document */ int preserve; /* whether to free the document */
int counter; /* used to give ononymous components unique names */ int counter; /* used to give ononymous components unique names */
xmlHashTablePtr idcDef; xmlHashTablePtr idcDef; /* All identity-constraint defs. */
void *volatiles; /* Deprecated; not used anymore. */ void *volatiles; /* Obsolete */
}; };
XMLPUBFUN void XMLCALL xmlSchemaFreeType (xmlSchemaTypePtr type); XMLPUBFUN void XMLCALL xmlSchemaFreeType (xmlSchemaTypePtr type);