wishlist: update some
[mplayer.git] / m_struct.h
index 2f7f16d..54ac17b 100644 (file)
@@ -1,28 +1,46 @@
-#ifndef _M_STRUCT_H
-#define _M_STRUCT_H
+/*
+ * This file is part of MPlayer.
+ *
+ * MPlayer is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 2 of the License, or
+ * (at your option) any later version.
+ *
+ * MPlayer is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License along
+ * with MPlayer; if not, write to the Free Software Foundation, Inc.,
+ * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+ */
+
+#ifndef MPLAYER_M_STRUCT_H
+#define MPLAYER_M_STRUCT_H
 
 /// \defgroup OptionsStruct Options struct
 /// \ingroup Options
 /// An API to manipulate structs using m_option.
 ///@{
 
-/// \file m_struct.h
+/// \file
 
 struct m_option;
 
 /// Struct definition
 typedef struct m_struct_st {
   /// For error messages and debugging
-  char* name;
+  const char* name;
   /// size of the whole struct
   unsigned int size;
   /// Pointer to a struct filled with the default settings
-  void* defaults;
+  const void* defaults;
   /// Field list.
   /** The p field of the \ref m_option struct must contain the offset
    *  of the member in the struct (use M_ST_OFF macro for this).
    */
-  struct m_option* fields;
+  const struct m_option* fields;
 } m_struct_t;
 
 
@@ -42,9 +60,9 @@ typedef struct m_struct_st {
  *  \return Pointer to the struct field.
  */
 #define M_ST_MB_P(struct_p, struct_offset)   \
-    ((void*) (struct_p) + (unsigned long) (struct_offset))
+    ((void *)((char *)(struct_p) + (unsigned long)(struct_offset)))
 
-/// Acces a struct field at a given offset.
+/// Access a struct field at a given offset.
 /** \param member_type Type of the field.
  *  \param struct_p Pointer to the struct.
  *  \param struct_offset Offset of the field in the struct.
@@ -60,7 +78,7 @@ typedef struct m_struct_st {
  *  \return The newly allocated object set to default.
  */
 void*
-m_struct_alloc(m_struct_t* st);
+m_struct_alloc(const m_struct_t* st);
 
 /// Set a field of the struct.
 /** \param st Struct definition.
@@ -70,39 +88,39 @@ m_struct_alloc(m_struct_t* st);
  *  \return 0 on error, 1 on success.
  */
 int
-m_struct_set(m_struct_t* st, void* obj, char* field, char* param);
+m_struct_set(const m_struct_t* st, void* obj, const char* field, const char* param);
 
 /// Reset a field (or all if field == NULL) to defaults.
-/** \param st Struct definiton.
+/** \param st Struct definition.
  *  \param obj Pointer to the struct to set.
  *  \param field Name of the field to reset, if NULL all fields are reseted.
  */
 void
-m_struct_reset(m_struct_t* st, void* obj, const char* field);
+m_struct_reset(const m_struct_t* st, void* obj, const char* field);
 
 /// Create a copy of an existing struct.
-/** \param st Struct definiton.
+/** \param st Struct definition.
  *  \param obj Pointer to the struct to copy.
  *  \return Newly allocated copy of obj.
  */
 void*
-m_struct_copy(m_struct_t* st, void* obj);
+m_struct_copy(const m_struct_t* st, void* obj);
 
 /// Free an allocated struct.
-/** \param st Struct definiton.
+/** \param st Struct definition.
  *  \param obj Pointer to the struct to copy.
  */
 void
-m_struct_free(m_struct_t* st, void* obj);
+m_struct_free(const m_struct_t* st, void* obj);
 
 /// Get a field description.
-/** \param st Struct definiton.
+/** \param st Struct definition.
  *  \param f Name of the field.
  *  \return The \ref m_option struct describing the field or NULL if not found.
  */
-struct m_option*
-m_struct_get_field(m_struct_t* st,const char* f);
+const struct m_option*
+m_struct_get_field(const m_struct_t* st,const char* f);
 
 ///@}
 
-#endif /* _M_STRUCT_H */
+#endif /* MPLAYER_M_STRUCT_H */