X-Git-Url: https://sigrok.org/gitweb/?p=libsigrokdecode.git;a=blobdiff_plain;f=decoder.c;h=6dfeecae7fa1fa5a5ca6e1c55eb7e27641ffcc49;hp=e039e377655382b2d9fdb0b9fcbf3fc028be0b03;hb=de2f532821bab1bef235ee65b38b0f4427bb9d5c;hpb=c9bfccc6347e05e6faba6f27fe0e50a7d55f531c diff --git a/decoder.c b/decoder.c index e039e37..6dfeeca 100644 --- a/decoder.c +++ b/decoder.c @@ -24,10 +24,10 @@ #include /* The list of protocol decoders. */ -GSList *pd_list = NULL; +SRD_PRIV GSList *pd_list = NULL; /* module_sigrokdecode.c */ -extern PyObject *mod_sigrokdecode; +extern SRD_PRIV PyObject *mod_sigrokdecode; /** * Returns the list of supported/loaded protocol decoders. @@ -36,7 +36,7 @@ extern PyObject *mod_sigrokdecode; * * @return List of decoders, NULL if none are supported or loaded. */ -GSList *srd_list_decoders(void) +SRD_API GSList *srd_decoder_list(void) { return pd_list; } @@ -45,14 +45,15 @@ GSList *srd_list_decoders(void) * 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_decoder_get_by_id(const char *id) { GSList *l; struct srd_decoder *dec; - for (l = srd_list_decoders(); l; l = l->next) { + for (l = srd_decoder_list(); l; l = l->next) { dec = l->data; if (!strcmp(dec->id, id)) return dec; @@ -61,7 +62,8 @@ 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) +static int get_probes(const struct srd_decoder *d, const char *attr, + GSList **pl) { PyObject *py_probelist, *py_entry; struct srd_probe *p; @@ -95,6 +97,7 @@ static int get_probes(struct srd_decoder *d, char *attr, GSList **pl) } 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; } @@ -121,24 +124,25 @@ err_out: /** * Load a protocol decoder module into the embedded Python interpreter. * - * @param name The module name to be loaded. - * @param dec Pointer to the struct srd_decoder filled with the loaded module. + * @param module_name The module name to be loaded. * * @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_decoder_load(const char *module_name) { PyObject *py_basedec, *py_method, *py_attr, *py_annlist, *py_ann; struct srd_decoder *d; int alen, ret, i; char **ann; + struct srd_probe *p; + GSList *l; - srd_dbg("Loading module '%s'.", name); + srd_dbg("Loading protocol decoder '%s'.", module_name); 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; } @@ -146,8 +150,8 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) ret = SRD_ERR_PYTHON; /* Import the Python module. */ - if (!(d->py_mod = PyImport_ImportModule(name))) { - catch_exception("import of '%s' failed.", name); + if (!(d->py_mod = PyImport_ImportModule(module_name))) { + srd_exception_catch("Import of '%s' failed.", module_name); goto err_out; } @@ -155,7 +159,8 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) if (!(d->py_dec = PyObject_GetAttrString(d->py_mod, "Decoder"))) { /* This generated an AttributeError exception. */ PyErr_Clear(); - srd_err("Decoder class not found in protocol decoder %s.", name); + srd_err("Decoder class not found in protocol decoder %s.", + module_name); goto err_out; } @@ -166,7 +171,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.", module_name); goto err_out; } Py_CLEAR(py_basedec); @@ -174,13 +179,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.", module_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.", module_name); goto err_out; } Py_CLEAR(py_method); @@ -188,13 +193,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.", module_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.", module_name); goto err_out; } Py_CLEAR(py_method); @@ -219,6 +224,19 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) if (get_probes(d, "optional_probes", &d->opt_probes) != SRD_OK) goto err_out; + /* + * Fix order numbers for the optional probes. + * + * Example: + * Required probes: r1, r2, r3. Optional: o1, o2, o3, o4. + * 'order' fields in the d->probes list = 0, 1, 2. + * 'order' fields in the d->opt_probes list = 3, 4, 5, 6. + */ + for (l = d->opt_probes; l; l = l->next) { + p = l->data; + p->order += g_slist_length(d->probes); + } + /* Store required fields in newly allocated strings. */ if (py_attr_as_str(d->py_dec, "id", &(d->id)) != SRD_OK) goto err_out; @@ -235,17 +253,13 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) if (py_attr_as_str(d->py_dec, "license", &(d->license)) != SRD_OK) goto err_out; - /* TODO: Handle inputformats, outputformats. */ - d->inputformats = NULL; - d->outputformats = NULL; - - /* Convert class annotation attribute to GSList of **char */ + /* Convert class annotation attribute to GSList of **char. */ d->annotations = NULL; 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); + "should be a list.", module_name); goto err_out; } alen = PyList_Size(py_annlist); @@ -254,7 +268,7 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) 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); + "two elements.", module_name, i + 1); goto err_out; } @@ -265,7 +279,9 @@ int srd_load_decoder(const char *name, struct srd_decoder **dec) } } - *dec = d; + /* Append it to the list of supported/loaded decoders. */ + pd_list = g_slist_append(pd_list, d); + ret = SRD_OK; err_out: @@ -280,7 +296,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 protocol decoder's + * documentation. The caller is responsible for free'ing the buffer. + */ +SRD_API char *srd_decoder_doc_get(const struct srd_decoder *dec) { PyObject *py_str; char *doc; @@ -289,7 +313,7 @@ char *srd_decoder_doc(struct srd_decoder *dec) return NULL; if (!(py_str = PyObject_GetAttrString(dec->py_mod, "__doc__"))) { - catch_exception(""); + srd_exception_catch(""); return NULL; } @@ -317,7 +341,6 @@ static void free_probes(GSList *probelist) g_free(p); } g_slist_free(probelist); - } /** @@ -327,16 +350,17 @@ 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_decoder_unload(struct srd_decoder *dec) { + srd_dbg("Unloading protocol decoder '%s'.", dec->name); - srd_dbg("unloading decoder %s", dec->name); - - /* Since any instances of this decoder need to be released as well, + /* + * 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); + * instances, and rebuild the stack. + */ + srd_inst_free_all(NULL); free_probes(dec->probes); free_probes(dec->opt_probes); @@ -346,12 +370,6 @@ int srd_unload_decoder(struct srd_decoder *dec) g_free(dec->desc); g_free(dec->license); - /* TODO: Free everything in inputformats and outputformats. */ - if (dec->inputformats != NULL) - g_slist_free(dec->inputformats); - if (dec->outputformats != NULL) - g_slist_free(dec->outputformats); - /* The module's Decoder class. */ Py_XDECREF(dec->py_dec); /* The module itself. */ @@ -362,27 +380,25 @@ int srd_unload_decoder(struct srd_decoder *dec) return SRD_OK; } -int srd_load_all_decoders(void) +/** + * Load all installed protocol decoders. + * + * @return SRD_OK upon success, a (negative) error code otherwise. + */ +SRD_API int srd_decoder_load_all(void) { GDir *dir; GError *error; - struct srd_decoder *dec; - int ret; const gchar *direntry; - char *decodername; if (!(dir = g_dir_open(DECODERS_DIR, 0, &error))) { + srd_err("Unable to open %s for reading.", DECODERS_DIR); return SRD_ERR_DECODERS_DIR; } while ((direntry = g_dir_read_name(dir)) != NULL) { - /* The decoder name is the PD directory name (e.g. "i2c"). */ - decodername = g_strdup(direntry); - - if ((ret = srd_load_decoder(decodername, &dec)) == SRD_OK) { - /* Append it to the list of supported/loaded decoders. */ - pd_list = g_slist_append(pd_list, dec); - } + /* The directory name is the module name (e.g. "i2c"). */ + srd_decoder_load(direntry); } g_dir_close(dir); @@ -390,16 +406,18 @@ 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_decoder_unload_all(void) { GSList *l; struct srd_decoder *dec; - for (l = srd_list_decoders(); l; l = l->next) { + for (l = srd_decoder_list(); l; l = l->next) { dec = l->data; - srd_unload_decoder(dec); + srd_decoder_unload(dec); } return SRD_OK;