davide carboni / Mbed 2 deprecated pymite_http_get

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   mbed

Embed: (wiki syntax)

« Back to documentation index

obj.h File Reference
Data Structures | Typedefs | Enumerations | Functions

obj.h File Reference

Object Type. More...

Go to the source code of this file.

Data Structures

struct  PmObj_s
 Object. More...
struct  PmBoolean_s
 Boolean object. More...

Typedefs

typedef enum PmType_e PmType_t
 Object type enum.
typedef uint16_t PmObjDesc_t
 Object Descriptor.
typedef struct PmObj_s PmObj_t
 Object.
typedef struct PmBoolean_s PmBoolean_t
 Boolean object.

Enumerations

enum  PmType_e { ,
  OBJ_TYPE_NON = 0x00, OBJ_TYPE_INT = 0x01, OBJ_TYPE_FLT = 0x02, OBJ_TYPE_STR = 0x03,
  OBJ_TYPE_TUP = 0x04, OBJ_TYPE_COB = 0x05, OBJ_TYPE_MOD = 0x06, OBJ_TYPE_CLO = 0x07,
  OBJ_TYPE_FXN = 0x08, OBJ_TYPE_CLI = 0x09, OBJ_TYPE_CIM = 0x0A, OBJ_TYPE_NIM = 0x0B,
  OBJ_TYPE_NOB = 0x0C, OBJ_TYPE_THR = 0x0D, OBJ_TYPE_BOOL = 0x0F, OBJ_TYPE_CIO = 0x10,
  OBJ_TYPE_MTH = 0x11 , OBJ_TYPE_LST = 0x12, OBJ_TYPE_DIC = 0x13, OBJ_TYPE_BYA = 0x14 ,
  OBJ_TYPE_BYS = 0x18, OBJ_TYPE_FRM = 0x19, OBJ_TYPE_BLK = 0x1A, OBJ_TYPE_SEG = 0x1B,
  OBJ_TYPE_SGL = 0x1C, OBJ_TYPE_SQI = 0x1D, OBJ_TYPE_NFM = 0x1E
}
 

Object type enum.

More...

Functions

PmReturn_t obj_loadFromImg (PmMemSpace_t memspace, uint8_t const **paddr, pPmObj_t *r_pobj)
 Loads an object from an image in memory.
PmReturn_t obj_loadFromImgObj (pPmObj_t pimg, pPmObj_t *r_pobj)
 Loads a code object from a code image object.
int8_t obj_isFalse (pPmObj_t pobj)
 Finds the boolean value of the given object.
PmReturn_t obj_isIn (pPmObj_t pobj, pPmObj_t pitem)
 Returns the boolean true if the item is in the object.
int8_t obj_compare (pPmObj_t pobj1, pPmObj_t pobj2)
 Compares two objects for equality.
PmReturn_t obj_print (pPmObj_t pobj, uint8_t marshallString)
 Print an object, thereby using objects helpers.
PmReturn_t obj_repr (pPmObj_t pobj, pPmObj_t *r_pstr)
 Returns by reference a string object that is the human-readable representation of the object.

Detailed Description

Object Type.

Object type header.

Definition in file obj.h.

Typedef Documentation

typedef struct PmBoolean_s PmBoolean_t

Boolean object.

typedef struct PmObj_s PmObj_t

Object.

The abstract empty object type for PyMite.

typedef uint16_t PmObjDesc_t

Object Descriptor.

All active PyMite "objects" must have this at the top of their struct. (CodeObj, Frame, Dict, List, Tuple, etc.).

The following is a diagram of the object descriptor:

MSb LSb 7 6 5 4 3 2 1 0 pchunk-> +-+-+-+-+-+-+-+-+ S := Size of the chunk (2 LSbs dropped) | S[9:2] | F := Free bit +-+-+---------+-+ M := GC Mark bit |F|M| T |S| T := Object type (PyMite specific) +-+-+---------+-+ | object data | ... ... | end data | Theoretical min size == 2 +---------------+ Effective min size == 8 (due to pmHeapDesc_t)

Macros are used to get and set field values. Using macros eliminates declaring bit fields which fails on some compilers.

Definition at line 251 of file obj.h.

typedef enum PmType_e PmType_t

Object type enum.

These values go in the od_type fields of the obj descriptor. Be sure these values correspond to those in the image creator tool. The hashable types are grouped together for convenience.

WARNING: od_type must be at most 5 bits! (must be < 0x20)

Enumeration Type Documentation

enum PmType_e

Object type enum.

These values go in the od_type fields of the obj descriptor. Be sure these values correspond to those in the image creator tool. The hashable types are grouped together for convenience.

WARNING: od_type must be at most 5 bits! (must be < 0x20)

Enumerator:
OBJ_TYPE_NON 

None.

OBJ_TYPE_INT 

Signed integer.

OBJ_TYPE_FLT 

Floating point 32b.

OBJ_TYPE_STR 

String.

OBJ_TYPE_TUP 

Tuple (immutable sequence)

OBJ_TYPE_COB 

Code obj.

OBJ_TYPE_MOD 

Module obj.

OBJ_TYPE_CLO 

Class obj.

OBJ_TYPE_FXN 

Function obj (callable)

OBJ_TYPE_CLI 

Class instance.

OBJ_TYPE_CIM 

Code image in static memory.

OBJ_TYPE_NIM 

Native function image.

OBJ_TYPE_NOB 

Native function object.

OBJ_TYPE_THR 

Thread.

OBJ_TYPE_BOOL 

Boolean object.

OBJ_TYPE_CIO 

Code image object.

OBJ_TYPE_MTH 

Method object.

OBJ_TYPE_LST 

List (mutable sequence)

OBJ_TYPE_DIC 

Dictionary (hash table)

OBJ_TYPE_BYA 

Bytearray (mutable)

OBJ_TYPE_BYS 

Bytes (mutable container for Bytearray type)

OBJ_TYPE_FRM 

Frame type.

OBJ_TYPE_BLK 

Block type (for,while,try,etc)

OBJ_TYPE_SEG 

Segment (within a seglist)

OBJ_TYPE_SGL 

Seglist.

OBJ_TYPE_SQI 

Sequence iterator.

OBJ_TYPE_NFM 

Native frame (there is only one)

Definition at line 130 of file obj.h.

Function Documentation

int8_t obj_compare ( pPmObj_t  pobj1,
pPmObj_t  pobj2 
)

Compares two objects for equality.

Parameters:
pobj1Ptr to first object.
pobj2Ptr to second object.
Returns:
C_SAME if the items are equivalent, C_DIFFER otherwise.

Definition at line 253 of file obj.c.

int8_t obj_isFalse ( pPmObj_t  pobj )

Finds the boolean value of the given object.

Parameters:
pobjPtr to object to test.
Returns:
Nonzero value if object is False.

Definition at line 110 of file obj.c.

PmReturn_t obj_isIn ( pPmObj_t  pobj,
pPmObj_t  pitem 
)

Returns the boolean true if the item is in the object.

Parameters:
pobjPtr to container object
pitemPtr to item

Definition at line 163 of file obj.c.

PmReturn_t obj_loadFromImg ( PmMemSpace_t  memspace,
uint8_t const **  paddr,
pPmObj_t *  r_pobj 
)

Loads an object from an image in memory.

Return pointer to object. Leave add pointing one byte past end of obj.

The following lists the simple object types and their image structures: -None: -type: int8_t - OBJ_TYPE_NON

-Int: -type: int8_t - OBJ_TYPE_INT -value: int32_t - signed integer value

-Float: -type: int8_t - OBJ_TYPE_FLOAT -value: float32_t - 32-bit floating point value

-Slice (is this allowed in img?): -type: int8_t - OBJ_TYPE_SLICE -index1: int16_t - first index. -index2: int16_t - second index.

Parameters:
memspacememory space/type
paddrptr to ptr to obj return by reference: paddr pts to first byte after obj
r_pobjReturn arg, the loaded object.
Returns:
Return status

Definition at line 32 of file obj.c.

PmReturn_t obj_loadFromImgObj ( pPmObj_t  pimg,
pPmObj_t *  r_pobj 
)

Loads a code object from a code image object.

Parameters:
pimgPtr to a code image object
r_pobjReturn arg, the loaded object
Returns:
Returns status

Definition at line 90 of file obj.c.

PmReturn_t obj_print ( pPmObj_t  pobj,
uint8_t  marshallString 
)

Print an object, thereby using objects helpers.

Parameters:
pobjPtr to object for printing.
marshallStringOnly has influence on the way strings are printed. If 0, just output the string bytewise. Otherwise, surround with single quotes and escape unprintable characters.
Returns:
Return status

Definition at line 344 of file obj.c.

PmReturn_t obj_repr ( pPmObj_t  pobj,
pPmObj_t *  r_pstr 
)

Returns by reference a string object that is the human-readable representation of the object.

Used by the backtick operation (UNARY_CONVERT).

Parameters:
pobjPtr to object to represent
r_pstrReturn arg, the string object
Returns:
Return status

Definition at line 469 of file obj.c.

Generated on Tue Jul 12 2022 17:07:01 by  doxygen 1.7.2