Changeset bff8619 in mainline for uspace/lib/sif/src/sif.c

Timestamp:

2024-08-20T22:07:31Z (2 months ago)

Author:

Jiri Svoboda <jiri@…>

Branches:

master

Children:

ac9b4f2

Parents:

a3ba37d

Message:

Simplify SIF interface, remove contacts

Remove transactions, move to a load/save model. Remove contacts
application as it was never finished and not useful at all.

File:

• uspace/lib/sif/src/sif.c (modified) (19 diffs)

uspace/lib/sif/src/sif.c

@@ -1 +1 @@
 /*
- * Copyright (c) 2023 Jiri Svoboda
+ * Copyright (c) 2024 Jiri Svoboda
  * All rights reserved.
  *
@@ -33 +33 @@
  *
  * Structured Information Format (SIF) is an API that allows an application
- * to maintain data in a persistent repository in a format that
- *
- *  - is structured (and hence extensible)
- *  - allows atomic (transactional) updates
- *  - allows efficient updates
+ * to maintain data in a persistent repository in a format that is
+ * structured (and hence extensible).
  *
  * SIF is meant to be used as the basis for the storage backend used to
@@ -44 +41 @@
  * similar to an XML document that contains just tags with attributes
  * (but no text).
- *
- * SIF can thus naturally express ordered lists (unlike a relational database).
- * When contrasted to a (relational) database, SIF is much more primitive.
- *
- * In particular, SIF
- *
- *  - does not run on a separate server
- *  - des not handle concurrency
- *  - does not have a notion of types or data validation
- *  - does not understand relations
- *  - does not implement any kind of search/queries
- *  - does not deal with data sets large enough not to fit in primary memory
- *
- * any kind of structure data validation is left up to the application.
  */
 
@@ -172 +155 @@
 }
 
-/** Create and open a SIF repository.
- *
- * @param fname File name
- * @param rsess Place to store pointer to new session.
+/** Create SIF document.
+ *
+ * @param rdoc Place to store pointer to new document.
  *
  * @return EOK on success or error code
  */
-errno_t sif_create(const char *fname, sif_sess_t **rsess)
-{
-        sif_sess_t *sess;
+errno_t sif_new(sif_doc_t **rdoc)
+{
+        sif_doc_t *doc;
         sif_node_t *root = NULL;
-        sif_trans_t *trans = NULL;
         errno_t rc;
-        FILE *f;
-
-        sess = calloc(1, sizeof(sif_sess_t));
-        if (sess == NULL)
-                return ENOMEM;
-
-        sess->fname = str_dup(fname);
-        if (sess->fname == NULL) {
-                rc = ENOMEM;
-                goto error;
-        }
+
+        doc = calloc(1, sizeof(sif_doc_t));
+        if (doc == NULL)
+                return ENOMEM;
 
         root = sif_node_new(NULL);
@@ -209 +183 @@
         }
 
-        f = fopen(fname, "wx");
-        if (f == NULL) {
-                rc = EIO;
-                goto error;
-        }
-
-        sess->f = f;
-        sess->root = root;
-
-        /* Run a dummy trasaction to marshall initial repo state to file */
-        rc = sif_trans_begin(sess, &trans);
-        if (rc != EOK)
-                goto error;
-
-        rc = sif_trans_end(trans);
-        if (rc != EOK)
-                goto error;
-
-        *rsess = sess;
+        doc->root = root;
+
+        *rdoc = doc;
         return EOK;
 error:
-        if (trans != NULL)
-                sif_trans_abort(trans);
         sif_node_delete(root);
-        if (sess->fname != NULL)
-                free(sess->fname);
-        free(sess);
+        free(doc);
         return rc;
 }
 
-/** Open an existing SIF repository.
+/** Load SIF document.
  *
  * @param fname File name
- * @param rsess Place to store pointer to new session.
+ * @param rdoc Place to store pointer to new document.
  *
  * @return EOK on success or error code
  */
-errno_t sif_open(const char *fname, sif_sess_t **rsess)
-{
-        sif_sess_t *sess;
+errno_t sif_load(const char *fname, sif_doc_t **rdoc)
+{
+        sif_doc_t *doc;
         sif_node_t *root = NULL;
         errno_t rc;
         FILE *f;
 
-        sess = calloc(1, sizeof(sif_sess_t));
-        if (sess == NULL)
-                return ENOMEM;
-
-        sess->fname = str_dup(fname);
-        if (sess->fname == NULL) {
+        doc = calloc(1, sizeof(sif_doc_t));
+        if (doc == NULL)
+                return ENOMEM;
+
+        doc->fname = str_dup(fname);
+        if (doc->fname == NULL) {
                 rc = ENOMEM;
                 goto error;
@@ -278 +232 @@
         }
 
-        sess->root = root;
-
-        sess->f = f;
-        sess->root = root;
-        *rsess = sess;
+        doc->root = root;
+        *rdoc = doc;
         return EOK;
 error:
         sif_node_delete(root);
-        if (sess->fname != NULL)
-                free(sess->fname);
-        free(sess);
+        free(doc);
         return rc;
 }
 
-/** Close SIF session.
- *
- * @param sess SIF session
+/** Delete SIF document.
+ *
+ * @param doc SIF document
  * @return EOK on success or error code
  */
-errno_t sif_close(sif_sess_t *sess)
-{
-        sif_node_delete(sess->root);
-
-        if (fclose(sess->f) < 0) {
-                free(sess);
-                return EIO;
-        }
-
-        if (sess->fname != NULL)
-                free(sess->fname);
-        free(sess);
-        return EOK;
+void sif_delete(sif_doc_t *doc)
+{
+        sif_node_delete(doc->root);
+        free(doc);
 }
 
 /** Return root node.
  *
- * @param sess SIF session
- */
-sif_node_t *sif_get_root(sif_sess_t *sess)
-{
-        return sess->root;
+ * @param doc SIF document
+ */
+sif_node_t *sif_get_root(sif_doc_t *doc)
+{
+        return doc->root;
 }
 
@@ -383 +323 @@
 }
 
-/** Begin SIF transaction.
- *
- * @param trans Transaction
+/** Save SIF document to file.
+ * *
+ * @param doc SIF document
+ * @param fname File name
  * @return EOK on success or error code
  */
-errno_t sif_trans_begin(sif_sess_t *sess, sif_trans_t **rtrans)
-{
-        sif_trans_t *trans;
-
-        trans = calloc(1, sizeof(sif_trans_t));
-        if (trans == NULL)
-                return ENOMEM;
-
-        trans->sess = sess;
-        *rtrans = trans;
-        return EOK;
-}
-
-/** Commit SIF transaction.
- *
- * Commit and free the transaction. If an error is returned, that means
- * the transaction has not been freed (and sif_trans_abort() must be used).
- *
- * @param trans Transaction
- * @return EOK on success or error code
- */
-errno_t sif_trans_end(sif_trans_t *trans)
-{
+errno_t sif_save(sif_doc_t *doc, const char *fname)
+{
+        FILE *f = NULL;
         errno_t rc;
 
-        (void) fclose(trans->sess->f);
-
-        trans->sess->f = fopen(trans->sess->fname, "w");
-        if (trans->sess->f == NULL)
-                return EIO;
-
-        rc = sif_export_node(trans->sess->root, trans->sess->f);
+        f = fopen(fname, "w");
+        if (f == NULL) {
+                rc = EIO;
+                goto error;
+        }
+
+        rc = sif_export_node(doc->root, f);
         if (rc != EOK)
-                return rc;
-
-        if (fputc('\n', trans->sess->f) == EOF)
-                return EIO;
-
-        if (fflush(trans->sess->f) == EOF)
-                return EIO;
-
-        free(trans);
-        return EOK;
-}
-
-/** Abort SIF transaction.
- *
- * @param trans Transaction
- */
-void sif_trans_abort(sif_trans_t *trans)
-{
-        free(trans);
+                goto error;
+
+        if (fputc('\n', f) == EOF) {
+                rc = EIO;
+                goto error;
+        }
+
+        if (fflush(f) == EOF) {
+                rc = EIO;
+                goto error;
+        }
+
+        return EOK;
+error:
+        if (f != NULL)
+                fclose(f);
+        return rc;
 }
 
@@ -447 +366 @@
  * @a parent.
  *
- * @param trans Transaction
  * @param parent Parent node
  * @param ctype Child type
@@ -454 +372 @@
  * @return EOK on success or ENOMEM if out of memory
  */
-errno_t sif_node_prepend_child(sif_trans_t *trans, sif_node_t *parent,
-    const char *ctype, sif_node_t **rchild)
+errno_t sif_node_prepend_child(sif_node_t *parent, const char *ctype,
+    sif_node_t **rchild)
 {
         sif_node_t *child;
@@ -479 +397 @@
  * Create a new child and append it at the end of children list of @a parent.
  *
- * @param trans Transaction
  * @param parent Parent node
  * @param ctype Child type
@@ -486 +403 @@
  * @return EOK on success or ENOMEM if out of memory
  */
-errno_t sif_node_append_child(sif_trans_t *trans, sif_node_t *parent,
-    const char *ctype, sif_node_t **rchild)
+errno_t sif_node_append_child(sif_node_t *parent, const char *ctype,
+    sif_node_t **rchild)
 {
         sif_node_t *child;
@@ -511 +428 @@
  * Create a new child and insert it before an existing child.
  *
- * @param trans Transaction
  * @param sibling Sibling before which to insert
  * @param ctype Child type
@@ -518 +434 @@
  * @return EOK on success or ENOMEM if out of memory
  */
-errno_t sif_node_insert_before(sif_trans_t *trans, sif_node_t *sibling,
-    const char *ctype, sif_node_t **rchild)
+errno_t sif_node_insert_before(sif_node_t *sibling, const char *ctype,
+    sif_node_t **rchild)
 {
         sif_node_t *child;
@@ -543 +459 @@
  * Create a new child and insert it after an existing child.
  *
- * @param trans Transaction
  * @param sibling Sibling after which to insert
  * @param ctype Child type
@@ -550 +465 @@
  * @return EOK on success or ENOMEM if out of memory
  */
-errno_t sif_node_insert_after(sif_trans_t *trans, sif_node_t *sibling,
-    const char *ctype, sif_node_t **rchild)
+errno_t sif_node_insert_after(sif_node_t *sibling, const char *ctype,
+    sif_node_t **rchild)
 {
         sif_node_t *child;
@@ -573 +488 @@
 /** Destroy SIF node.
  *
- * This function does not return an error, but the transaction may still
- * fail to complete.
- *
- * @param trans Transaction
  * @param node Node to destroy
  */
-void sif_node_destroy(sif_trans_t *trans, sif_node_t *node)
+void sif_node_destroy(sif_node_t *node)
 {
         list_remove(&node->lparent);
@@ -587 +498 @@
 /** Set node attribute.
  *
- * @param trans Transaction
  * @param node SIF node
  * @param aname Attribute name
@@ -594 +504 @@
  * @return EOK on success, ENOMEM if out of memory
  */
-errno_t sif_node_set_attr(sif_trans_t *trans, sif_node_t *node,
-    const char *aname, const char *avalue)
+errno_t sif_node_set_attr(sif_node_t *node, const char *aname,
+    const char *avalue)
 {
         odlink_t *link;
@@ -636 +546 @@
 /** Unset node attribute.
  *
- * This function does not return an error, but the transaction may still
- * fail to complete.
- *
- * @param trans Transaction
  * @param node Node
  * @param aname Attribute name
  */
-void sif_node_unset_attr(sif_trans_t *trans, sif_node_t *node,
-    const char *aname)
+void sif_node_unset_attr(sif_node_t *node, const char *aname)
 {
         odlink_t *link;