summaryrefslogtreecommitdiffstats
path: root/axiom/include/axiom_doctype.h
diff options
context:
space:
mode:
Diffstat (limited to 'axiom/include/axiom_doctype.h')
-rw-r--r--axiom/include/axiom_doctype.h120
1 files changed, 120 insertions, 0 deletions
diff --git a/axiom/include/axiom_doctype.h b/axiom/include/axiom_doctype.h
new file mode 100644
index 0000000..a054c6e
--- /dev/null
+++ b/axiom/include/axiom_doctype.h
@@ -0,0 +1,120 @@
+
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+#ifndef AXIOM_DOCTYPE_H
+#define AXIOM_DOCTYPE_H
+
+/**
+ *@file axiom_doctype.h
+ *@brief defines struct representing xml DTD and its manipulation functions
+ */
+
+#include <axiom_node.h>
+#include <axiom_output.h>
+
+#ifdef __cplusplus
+extern "C"
+{
+#endif
+
+ struct axiom_doctype;
+ struct axiom_doctype_ops;
+
+ /**
+ * @defgroup axiom_doctype doctype
+ * @ingroup axiom_om
+ * @{
+ */
+
+ typedef struct axiom_doctype axiom_doctype_t;
+
+ /**
+ * Creates a axiom_doctype_t struct
+ * @param env Environment. MUST NOT be NULL,
+ * @param parent parent of the new node. Optinal, can be NULL.
+ * @param value doctype text
+ * @param node This is an out parameter.cannot be NULL.
+ * Returns the node corresponding to the doctype created.
+ * Node type will be set to AXIOM_DOCTYPE
+ * @return pointer to newly created doctype struct
+ */
+ AXIS2_EXTERN axiom_doctype_t *AXIS2_CALL
+ axiom_doctype_create(
+ const axutil_env_t * env,
+ axiom_node_t * parent,
+ const axis2_char_t * value,
+ axiom_node_t ** node);
+
+ /**
+ * free doctype struct
+ * @param om_doctype pointer to axiom_doctype_t struct to be freed
+ * @param env Environment. MUST NOT be NULL,
+ * @return satus of the op. AXIS2_SUCCESS on success
+ * AXIS2_FAILURE on error.
+ */
+ AXIS2_EXTERN void AXIS2_CALL
+ axiom_doctype_free(
+ struct axiom_doctype *om_doctype,
+ const axutil_env_t * env);
+
+ /**
+ * @param om_doctype pointer to a axiom_doctype_t struct
+ * @param env environment must not be null
+ * @return DTD text
+ */
+ AXIS2_EXTERN axis2_char_t *AXIS2_CALL
+ axiom_doctype_get_value(
+ struct axiom_doctype *om_doctype,
+ const axutil_env_t * env);
+
+ /**
+ * @param om_doctype pointer to axiom doctype_t struct
+ * @param env environment , MUST NOT be NULL.
+ * @param value doctype text value
+ * @return status of the op,
+ * AXIS2_SUCCESS on success, AXIS2_FAILURE on error.
+ */
+
+ AXIS2_EXTERN axis2_status_t AXIS2_CALL
+ axiom_doctype_set_value(
+ struct axiom_doctype *om_doctype,
+ const axutil_env_t * env,
+ const axis2_char_t * value);
+
+ /**
+ * serialize op
+ * @param om_doctype pointer to axiom_doctype_t struct
+ * @param env environment , MUST NOT be NULL
+ * @param om_output pointer to axiom_output_t struct
+ * @returns status of the op,
+ * AXIS2_SUCCESS on success, AXIS2_FAILURE on error.
+ */
+
+ AXIS2_EXTERN axis2_status_t AXIS2_CALL
+ axiom_doctype_serialize(
+ struct axiom_doctype *om_doctype,
+ const axutil_env_t * env,
+ axiom_output_t * om_output);
+
+ /** @} */
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif /* AXIOM_DOCTYPE_H */