Norimasa Okamoto
python-on-a-chip online compiler
dict.h File Reference
Dict Object Type. More...
Go to the source code of this file.
Data Structures | |
| struct | PmDict_s |
| Dict. More... | |
Typedefs | |
| typedef struct PmDict_s | PmDict_t |
| Dict. | |
Functions | |
| PmReturn_t | dict_clear (pPmObj_t pdict) |
| Clears the contents of a dict. | |
| PmReturn_t | dict_getItem (pPmObj_t pdict, pPmObj_t pkey, pPmObj_t *r_pobj) |
| Gets the value in the dict using the given key. | |
| PmReturn_t | dict_delItem (pPmObj_t pdict, pPmObj_t pkey) |
| Removes a key and value from the dict. | |
| PmReturn_t | dict_new (pPmObj_t *r_pdict) |
| Allocates space for a new Dict. | |
| PmReturn_t | dict_setItem (pPmObj_t pdict, pPmObj_t pkey, pPmObj_t pval) |
| Sets a value in the dict using the given key. | |
| PmReturn_t | dict_print (pPmObj_t pdict) |
| Prints out a dict. | |
| PmReturn_t | dict_update (pPmObj_t pdestdict, pPmObj_t psourcedict, uint8_t omit_underscored) |
| Updates the destination dict with the key,value pairs from the source dict. | |
| int8_t | dict_compare (pPmObj_t d1, pPmObj_t d2) |
| Returns C_SAME if the two given dictionaries have the same contents. | |
Detailed Description
Dict Object Type.
Dict object type header.
Definition in file dict.h.
Typedef Documentation
Dict.
Contains ptr to two seglists, one for keys, the other for values; and a length, the number of key/value pairs.
Function Documentation
| PmReturn_t dict_clear | ( | pPmObj_t | pdict ) |
Clears the contents of a dict.
after this operation, the dict should in the same state as if it were just created using dict_new().
- Parameters:
-
pdict ptr to dict to clear.
- Returns:
- nothing
| PmReturn_t dict_delItem | ( | pPmObj_t | pdict, |
| pPmObj_t | pkey | ||
| ) |
| PmReturn_t dict_getItem | ( | pPmObj_t | pdict, |
| pPmObj_t | pkey, | ||
| pPmObj_t * | r_pobj | ||
| ) |
| PmReturn_t dict_new | ( | pPmObj_t * | r_pdict ) |
| PmReturn_t dict_print | ( | pPmObj_t | pdict ) |
Prints out a dict.
Uses obj_print() to print elements.
- Parameters:
-
pobj Object to print.
- Returns:
- Return status
| PmReturn_t dict_setItem | ( | pPmObj_t | pdict, |
| pPmObj_t | pkey, | ||
| pPmObj_t | pval | ||
| ) |
Sets a value in the dict using the given key.
If the dict already contains a matching key, the value is replaced; otherwise the new key,val pair is inserted at the front of the dict (for fast lookup). In the later case, the length of the dict is incremented.
- Parameters:
-
pdict ptr to dict in which (key,val) will go pkey ptr to key obj pval ptr to val obj
- Returns:
- Return status
| PmReturn_t dict_update | ( | pPmObj_t | pdestdict, |
| pPmObj_t | psourcedict, | ||
| uint8_t | omit_underscored | ||
| ) |
Updates the destination dict with the key,value pairs from the source dict.
- Parameters:
-
pdestdict ptr to destination dict in which key,val pairs will go psourcedict ptr to source dict which has all key,val pairs to copy omit_underscored Boolean set to true to omit key,val pairs where the key starts with an underscore '_'.
- Returns:
- Return status
Generated on Tue Jul 12 2022 23:13:47 by
1.7.2