X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=e3f847d205ea7db534ad9e93b2372fb7bf057774;hp=83735a7ec3442ae30a199393b376db0b5a1d6836;hb=582c8473ffd456dfb0796974ef2c0b1b78de38a8;hpb=fa12a21e3c779df4e33dcfe394e2ded3f96028ce diff --git a/decoder.c b/decoder.c index 83735a7..e3f847d 100644 --- a/decoder.c +++ b/decoder.c @@ -24,11 +24,10 @@ #include /* The list of protocol decoders. */ -GSList *pd_list = NULL; - -/* lives in module_sigrokdecode.c */ -extern PyObject *mod_sigrokdecode; +SRD_PRIV GSList *pd_list = NULL; +/* module_sigrokdecode.c */ +extern SRD_PRIV PyObject *mod_sigrokdecode; /** * Returns the list of supported/loaded protocol decoders. @@ -37,20 +36,19 @@ extern PyObject *mod_sigrokdecode; * * @return List of decoders, NULL if none are supported or loaded. */ -GSList *srd_list_decoders(void) +SRD_API GSList *srd_list_decoders(void) { - return pd_list; } - /** * Get the decoder with the specified ID. * * @param id The ID string of the decoder to return. + * * @return The decoder with the specified ID, or NULL if not found. */ -struct srd_decoder *srd_get_decoder_by_id(const char *id) +SRD_API struct srd_decoder *srd_get_decoder_by_id(const char *id) { GSList *l; struct srd_decoder *dec; @@ -64,7 +62,6 @@ struct srd_decoder *srd_get_decoder_by_id(const char *id) return NULL; } - static int get_probes(struct srd_decoder *d, char *attr, GSList **pl) { PyObject *py_probelist, *py_entry; @@ -81,7 +78,7 @@ static int get_probes(struct srd_decoder *d, char *attr, GSList **pl) py_probelist = PyObject_GetAttrString(d->py_dec, attr); if (!PyList_Check(py_probelist)) { srd_err("Protocol decoder %s %s attribute is not " - "a list.", d->name, attr); + "a list.", d->name, attr); goto err_out; } @@ -94,11 +91,12 @@ static int get_probes(struct srd_decoder *d, char *attr, GSList **pl) py_entry = PyList_GetItem(py_probelist, i); if (!PyDict_Check(py_entry)) { srd_err("Protocol decoder %s %s attribute is not " - "a list with dict elements.", d->name, attr); + "a list with dict elements.", d->name, attr); goto err_out; } if (!(p = g_try_malloc(sizeof(struct srd_probe)))) { + srd_err("Failed to g_malloc() struct srd_probe."); ret = SRD_ERR_MALLOC; goto err_out; } @@ -130,7 +128,7 @@ err_out: * * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_load_decoder(const char *name, struct srd_decoder **dec) +SRD_API int srd_load_decoder(const char *name, struct srd_decoder **dec) { PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann; struct srd_decoder *d; @@ -142,7 +140,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) py_basedec = py_method = py_attr = NULL; if (!(d = g_try_malloc0(sizeof(struct srd_decoder)))) { - srd_dbg("Failed to malloc struct srd_decoder."); + srd_dbg("Failed to g_malloc() struct srd_decoder."); ret = SRD_ERR_MALLOC; goto err_out; } @@ -170,7 +168,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) if (!PyObject_IsSubclass(d->py_dec, py_basedec)) { srd_err("Decoder class in protocol decoder module %s is not " - "a subclass of sigrokdecode.Decoder.", name); + "a subclass of sigrokdecode.Decoder.", name); goto err_out; } Py_CLEAR(py_basedec); @@ -178,13 +176,13 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) /* Check for a proper start() method. */ if (!PyObject_HasAttrString(d->py_dec, "start")) { srd_err("Protocol decoder %s has no start() method Decoder " - "class.", name); + "class.", name); goto err_out; } py_method = PyObject_GetAttrString(d->py_dec, "start"); if (!PyFunction_Check(py_method)) { srd_err("Protocol decoder %s Decoder class attribute 'start' " - "is not a method.", name); + "is not a method.", name); goto err_out; } Py_CLEAR(py_method); @@ -192,13 +190,13 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) /* Check for a proper decode() method. */ if (!PyObject_HasAttrString(d->py_dec, "decode")) { srd_err("Protocol decoder %s has no decode() method Decoder " - "class.", name); + "class.", name); goto err_out; } py_method = PyObject_GetAttrString(d->py_dec, "decode"); if (!PyFunction_Check(py_method)) { srd_err("Protocol decoder %s Decoder class attribute 'decode' " - "is not a method.", name); + "is not a method.", name); goto err_out; } Py_CLEAR(py_method); @@ -208,7 +206,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) py_attr = PyObject_GetAttrString(d->py_dec, "options"); if (!PyDict_Check(py_attr)) { srd_err("Protocol decoder %s options attribute is not " - "a dictionary.", d->name); + "a dictionary.", d->name); Py_DecRef(py_attr); goto err_out; } @@ -220,7 +218,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) goto err_out; /* Check and import optional probes. */ - if (get_probes(d, "extra_probes", &d->extra_probes) != SRD_OK) + if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK) goto err_out; /* Store required fields in newly allocated strings. */ @@ -248,15 +246,17 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) if (PyObject_HasAttrString(d->py_dec, "annotations")) { py_annlist = PyObject_GetAttrString(d->py_dec, "annotations"); if (!PyList_Check(py_annlist)) { - srd_err("Protocol decoder module %s annotations should be a list.", name); + srd_err("Protocol decoder module %s annotations " + "should be a list.", name); goto err_out; } alen = PyList_Size(py_annlist); for (i = 0; i < alen; i++) { py_ann = PyList_GetItem(py_annlist, i); if (!PyList_Check(py_ann) || PyList_Size(py_ann) != 2) { - srd_err("Protocol decoder module %s annotation %d should " - "be a list with two elements.", name, i+1); + srd_err("Protocol decoder module %s " + "annotation %d should be a list with " + "two elements.", name, i + 1); goto err_out; } @@ -282,7 +282,15 @@ err_out: return ret; } -char *srd_decoder_doc(struct srd_decoder *dec) +/** + * Return a protocol decoder's docstring. + * + * @param dec The loaded protocol decoder. + * + * @return A newly allocated buffer containing the docstring. The caller should + * free this after use. + */ +SRD_API char *srd_decoder_doc(struct srd_decoder *dec) { PyObject *py_str; char *doc; @@ -303,7 +311,6 @@ char *srd_decoder_doc(struct srd_decoder *dec) return doc; } - static void free_probes(GSList *probelist) { GSList *l; @@ -330,19 +337,18 @@ static void free_probes(GSList *probelist) * * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_unload_decoder(struct srd_decoder *dec) +SRD_API int srd_unload_decoder(struct srd_decoder *dec) { - srd_dbg("unloading decoder %s", dec->name); /* Since any instances of this decoder need to be released as well, * but they could be anywhere in the stack, just free the entire * stack. A frontend reloading a decoder thus has to restart all * instances, and rebuild the stack. */ - srd_instance_free_all(NULL); + srd_inst_free_all(NULL); free_probes(dec->probes); - free_probes(dec->extra_probes); + free_probes(dec->opt_probes); g_free(dec->id); g_free(dec->name); g_free(dec->longname); @@ -365,7 +371,12 @@ int srd_unload_decoder(struct srd_decoder *dec) return SRD_OK; } -int srd_load_all_decoders(void) +/** + * Load all protocol decoders libsigrokdecode knows about. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + */ +SRD_API int srd_load_all_decoders(void) { GDir *dir; GError *error; @@ -393,9 +404,11 @@ int srd_load_all_decoders(void) } /** - * TODO + * Unload all loaded protocol decoders. + * + * @return SRD_OK upon success, a (negative) error code otherwise. */ -int srd_unload_all_decoders(void) +SRD_API int srd_unload_all_decoders(void) { GSList *l; struct srd_decoder *dec; @@ -407,6 +420,3 @@ int srd_unload_all_decoders(void) return SRD_OK; } - - -