[pulseaudio-discuss] [RFC v1 1/6] core: Rename pa_available_t to pa_available_t

[David Henningsson]

On 02/18/2013 09:10 AM, Mikel Astiz wrote:
> From: Mikel Astiz <mikel.astiz at bmw-carit.de>

The subject line doesn't indicate much of a change :-)


> diff --git a/src/pulse/def.h b/src/pulse/def.h
> index b939319..9067277 100644
> --- a/src/pulse/def.h
> +++ b/src/pulse/def.h
> @@ -991,18 +991,18 @@ typedef void (*pa_free_cb_t)(void *p);
>    * playback, \since 1.0 */
>   #define PA_STREAM_EVENT_FORMAT_LOST "format-lost"
>
> -/** Port availability / jack detection status
> +/** Availability flag (i.e. jack detection status)
>    * \since 2.0 */
> -typedef enum pa_port_available {
> -    PA_PORT_AVAILABLE_UNKNOWN = 0, /**< This port does not support jack detection \since 2.0 */
> -    PA_PORT_AVAILABLE_NO = 1,      /**< This port is not available, likely because the jack is not plugged in. \since 2.0 */
> -    PA_PORT_AVAILABLE_YES = 2,     /**< This port is available, likely because the jack is plugged in. \since 2.0 */
> -} pa_port_available_t;
> +typedef enum pa_available {
> +    PA_AVAILABLE_UNKNOWN = 0, /**< Not supported or information not available \since 2.0 */
> +    PA_AVAILABLE_NO = 1,      /**< Not available (i.e. with ports, likely because the jack is not plugged in) \since 2.0 */
> +    PA_AVAILABLE_YES = 2,     /**< Available (i.e. with ports, likely because the jack is plugged in) \since 2.0 */
> +} pa_available_t;
>
>   /** \cond fulldocs */
> -#define PA_PORT_AVAILABLE_UNKNOWN PA_PORT_AVAILABLE_UNKNOWN
> -#define PA_PORT_AVAILABLE_NO PA_PORT_AVAILABLE_NO
> -#define PA_PORT_AVAILABLE_YES PA_PORT_AVAILABLE_YES
> +#define PA_AVAILABLE_UNKNOWN PA_AVAILABLE_UNKNOWN
> +#define PA_AVAILABLE_NO PA_AVAILABLE_NO
> +#define PA_AVAILABLE_YES PA_AVAILABLE_YES

We're also going to need to still define (but possibly deprecate) 
PA_PORT_AVAILABLE_*, because it is used in client software, and we don't 
want to break the API.


-- 
David Henningsson, Canonical Ltd.
https://launchpad.net/~diwic