diff options
author | Wim Taymans <wim.taymans@gmail.com> | 2005-03-07 18:27:42 +0000 |
---|---|---|
committer | Wim Taymans <wim.taymans@gmail.com> | 2005-03-07 18:27:42 +0000 |
commit | c47dc4d8537a2cf09e830b8e8fef455306bb7e3e (patch) | |
tree | 52648c38eaf8eb9b206078ad5f134ec5f3fa914b /docs/design/part-conventions.txt | |
parent | d5e9b91e0aa074b93135300a5e31a6e0a850a18c (diff) |
First THREADED backport attempt, focusing on adding locks and making sure the API is threadsafe. Needs more work. Mor...
Original commit message from CVS:
First THREADED backport attempt, focusing on adding locks and
making sure the API is threadsafe. Needs more work. More docs
follow this week.
Diffstat (limited to 'docs/design/part-conventions.txt')
-rw-r--r-- | docs/design/part-conventions.txt | 56 |
1 files changed, 54 insertions, 2 deletions
diff --git a/docs/design/part-conventions.txt b/docs/design/part-conventions.txt index da634b8f5a..f2610a7278 100644 --- a/docs/design/part-conventions.txt +++ b/docs/design/part-conventions.txt @@ -16,7 +16,7 @@ Function names -------------- Within the context of a given object, functions defined in that object's header and/or source file will have their -object-specific prefix stripped. For instance, gst_element_add_pad() would be referred to as simply _get_pad(). Note +object-specific prefix stripped. For instance, gst_element_add_pad() would be referred to as simply _add_pad(). Note that the trailing parentheses should always be present, but sometimes may not be. A prefixing underscore (_) will always tell you it's a function, however, regardless of the presence or absence of the trailing parentheses. @@ -25,7 +25,59 @@ always tell you it's a function, however, regardless of the presence or absence Values and macros defined as enums and preprocessor macros will be referred to in all capitals, as per their definition. This includes object flags and element states, as well as general enums. Examples are the states NULL, -READY, PLAYING, and PAUSED; the element flags DECOUPLED and USE_COTHREAD, and state return values SUCCESS, FAILURE, and +READY, PLAYING, and PAUSED; the element flags LOCKED_STATE , and state return values SUCCESS, FAILURE, and ASYNC. Where there is a prefix, as in the element flags, this is usually dropped, and implied. Not however that element flags should be cross-checked with the header, as there are currently two conventions in use: with and without _FLAGS_ in the middle. + +FIXME: check flags for consistency. + +Drawing conventions +=================== + +When drawing pictures the folowing conventions apply: + +objects +------- + +Objects are drawn with a box like + +------+ + | | + +------+ + + +pointers +-------- + +a pointer to an object. + +-----+ + *--->| | + +-----+ + +an invalid pointer, this is a pointer that should not be used. + + *-//-> + + +elements +-------- + + +----------+ + | name | + sink src + +----------+ + +pad links +--------- + + -----+ +--- + | | + src--sink + -----+ +--- + + + + + + + |