git.sesse.net Git - vlc/blob - doc/headers

   1 Schéma de dépendance des headers et règles d'écriture
   2 =====================================================
   3
   4 Ce document décrit les dépendances entre les différents headers utilisés
   5 par le projet, ainsi que l'ordre dans lequel ils devraient être appelés.
   6 La totalité de ces headers, dans l'ordre, est regroupé dans le fichier
   7 "all.h", pour faciliter la mise en place de nouvelles structures.
   8
   9 Les headers inscrits entre parenthèses sont nécessaires indirectement.
  10
  11 Merci de maintenir ce fichier à jour.
  12
  13 Headers systèmes (appelés par ordre de repertoire et alphabetique)
  14 ------------------------------------------------------------------
  15
  16 #include <pthread.h>
  17 #include <netinet/in.h>
  18 #include <sys/soundcard.h>
  19 #include <sys/uio.h>
  20 #include <X11/Xlib.h>
  21 #include <X11/extensions/XShm.h>
  22 #include <X11/xpm.h>
  23
  24 Headers communs
  25 ---------------
  26
  27 #include "config.h"
  28 #include "common.h"         -> may depend of "config.h"
  29 #include "mtime.h"
  30 #include "netutils.h"       -> <netinet/in.h>
  31 #include "xutils.h"         -> <X11/Xlib.h>
  32
  33
  34 Input
  35 -----
  36
  37 #include "input.h"          -> <pthread.h>, <sys/uio.h>, "config.h", "common.h"
  38 #include "input_vlan.h"     -> <pthread>, <netinet/in.h>
  39 #include "decoder_fifo.h"   -> <pthread.h>, (<sys/uio.h>), ("config.h"), ("common.h"), "input.h"
  40 #include "netlist.h"        -> <prhtread.h>, (<sys/uio.h>), "config.h", ("common.h"), "input.h"
  41 #include "pcr.h"            -> (<pthread.h>), (<sys/uio.h>), ("config.h"), ("common.h"), "input.h"
  42 #include "psi.h"            -> (<pthread.h>), (<sys/uio.h>), ("config.h"), ("common.h"), "input.h"
  43
  44 Audio
  45 -----
  46
  47 #include "audio_decoder.h"  -> *le néant :)*
  48 #include "audio_output.h"   -> <pthread.h>, <sys/soundcard.h>, "config.h", "common.h", "mtime.h"
  49 #include "audio_dsp.h"      -> (<pthread.h>), (<sys/soundcard.h>), ("config.h"), ("common.h"),
  50                                 ("mtime.h"), "audio_output.h"
  51
  52 Video
  53 -----
  54
  55 #include "video.h"          -> ("config.h"), "common.h", "mtime.h"
  56 #include "video_graphics.h" -> ("config.h"), ("common.h"), ("mtime.h"), "video.h"
  57 #include "video_output.h"   -> <pthread.h>, "config.h", "common.h", ("mtime.h"), "video.h"
  58 #include "video_x11.h"      -> (<pthread.h>) <X11/Xlib.h>, <X11/extensions/XShm.h>,
  59                                 ("config.h"), ("common.h"), ("mtime.h"), "video.h", "video_output.h"
  60 #include "video_decoder.h"  -> <pthread.h>, (<sys/uio.h>), ("config.h"), "common.h", ("mtime.h"),
  61                                 "input.h", "decoder_fifo.h", ("video.h"), "video_output.h"
  62
  63 Interface
  64 ---------
  65
  66 #include "xconsole.h"       -> <X11/Xlib.h>, "config.h"
  67 #include "interface.h"      -> (<pthread.h>), (<sys/uio.h>), (<X11/Xlib.h>),
  68                                 (<X11/extensions/XShm.h>), "config.h", "common.h", ("mtime.h"),
  69                                 "input.h", ("video.h"), "video_output.h", "xconsole.h"
  70 #include "intf_msg.h"       -> <pthread.h>, "config.h", "common.h", "mtime.h"
  71 #include "intf_cmd.h"
  72 #include "control.h"        -> ??
  73 #include "intf_ctrl.h"      -> "intf_cmd.h"
  74
  75 Ressources partagées
  76 --------------------
  77
  78 #include "pgm_data.h"       -> (<pthread.h>), (<netinet/in.h>), (<sys/soundcard.h>), (<sys/uio.h>),
  79                                 (<X11/Xlib.h>),
  80                                 (<X11/extensions/XShm.h>), ("config.h"), "common.h", ("mtime.h"),
  81                                 "input.h", "input_vlan.h", "audio_output.h" , "video.h",
  82                                 ("video_output.h"), "xconsole.h", "interface.h", "intf_msg.h"
  83
  84 Autres headers, qui sont condamnés à disparaitre ou ne sont pas utilisés
  85 ------------------------------------------------------------------------
  86
  87 #include "network.h"    illisible, uniquement utilisé dans network.c
  88 #include "rsc_files.h"
  89 xconsole will also change
  90
  91
  92
  93
  94
  95
  96