[libcamera-devel,3/3] libcamera: Include header related to source file first

1064 diff mbox series

Include the header file corresponding to the source file in the very
first position. This complies with the Google C++ coding style
guideliens, and helps ensuring that the headers are self-contained.

Three bugs are already caught by this change (missing includes or
forward declarations) in device_enumerator.h, event_dispatcher_poll.h
and pipeline_handler.h. Fix them.

Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
---
 src/libcamera/buffer.cpp                      | 4 ++--
 src/libcamera/camera.cpp                      | 5 +++--
 src/libcamera/camera_manager.cpp              | 3 ++-
 src/libcamera/camera_sensor.cpp               | 3 ++-
 src/libcamera/device_enumerator.cpp           | 3 ++-
 src/libcamera/event_dispatcher_poll.cpp       | 3 ++-
 src/libcamera/event_notifier.cpp              | 3 ++-
 src/libcamera/geometry.cpp                    | 4 ++--
 src/libcamera/include/device_enumerator.h     | 3 +++
 src/libcamera/include/event_dispatcher_poll.h | 2 ++
 src/libcamera/include/pipeline_handler.h      | 1 +
 src/libcamera/log.cpp                         | 3 ++-
 src/libcamera/media_device.cpp                | 3 ++-
 src/libcamera/media_object.cpp                | 3 ++-
 src/libcamera/object.cpp                      | 1 +
 src/libcamera/pipeline_handler.cpp            | 3 ++-
 src/libcamera/request.cpp                     | 3 ++-
 src/libcamera/signal.cpp                      | 2 ++
 src/libcamera/stream.cpp                      | 4 ++--
 src/libcamera/timer.cpp                       | 3 ++-
 src/libcamera/utils.cpp                       | 4 ++--
 src/libcamera/v4l2_device.cpp                 | 3 ++-
 src/libcamera/v4l2_subdevice.cpp              | 3 ++-
 23 files changed, 46 insertions(+), 23 deletions(-)

Hi Laurent,
   thank you for the effort.

Reviewed-by: Jacopo Mondi <jacopo@jmondi.org>

Thanks
  j

On Thu, Apr 18, 2019 at 06:44:53PM +0300, Laurent Pinchart wrote:
> Include the header file corresponding to the source file in the very
> first position. This complies with the Google C++ coding style
> guideliens, and helps ensuring that the headers are self-contained.
>
> Three bugs are already caught by this change (missing includes or
> forward declarations) in device_enumerator.h, event_dispatcher_poll.h
> and pipeline_handler.h. Fix them.
>
> Signed-off-by: Laurent Pinchart <laurent.pinchart@ideasonboard.com>
> ---
>  src/libcamera/buffer.cpp                      | 4 ++--
>  src/libcamera/camera.cpp                      | 5 +++--
>  src/libcamera/camera_manager.cpp              | 3 ++-
>  src/libcamera/camera_sensor.cpp               | 3 ++-
>  src/libcamera/device_enumerator.cpp           | 3 ++-
>  src/libcamera/event_dispatcher_poll.cpp       | 3 ++-
>  src/libcamera/event_notifier.cpp              | 3 ++-
>  src/libcamera/geometry.cpp                    | 4 ++--
>  src/libcamera/include/device_enumerator.h     | 3 +++
>  src/libcamera/include/event_dispatcher_poll.h | 2 ++
>  src/libcamera/include/pipeline_handler.h      | 1 +
>  src/libcamera/log.cpp                         | 3 ++-
>  src/libcamera/media_device.cpp                | 3 ++-
>  src/libcamera/media_object.cpp                | 3 ++-
>  src/libcamera/object.cpp                      | 1 +
>  src/libcamera/pipeline_handler.cpp            | 3 ++-
>  src/libcamera/request.cpp                     | 3 ++-
>  src/libcamera/signal.cpp                      | 2 ++
>  src/libcamera/stream.cpp                      | 4 ++--
>  src/libcamera/timer.cpp                       | 3 ++-
>  src/libcamera/utils.cpp                       | 4 ++--
>  src/libcamera/v4l2_device.cpp                 | 3 ++-
>  src/libcamera/v4l2_subdevice.cpp              | 3 ++-
>  23 files changed, 46 insertions(+), 23 deletions(-)
>
> diff --git a/src/libcamera/buffer.cpp b/src/libcamera/buffer.cpp
> index 21abdcce56b9..d86278a8a90a 100644
> --- a/src/libcamera/buffer.cpp
> +++ b/src/libcamera/buffer.cpp
> @@ -5,13 +5,13 @@
>   * buffer.cpp - Buffer handling
>   */
>
> +#include <libcamera/buffer.h>
> +
>  #include <errno.h>
>  #include <string.h>
>  #include <sys/mman.h>
>  #include <unistd.h>
>
> -#include <libcamera/buffer.h>
> -
>  #include "log.h"
>
>  /**
> diff --git a/src/libcamera/camera.cpp b/src/libcamera/camera.cpp
> index a52769626446..d7a39ca6af12 100644
> --- a/src/libcamera/camera.cpp
> +++ b/src/libcamera/camera.cpp
> @@ -5,9 +5,10 @@
>   * camera.cpp - Camera device
>   */
>
> -#include <iomanip>
> -
>  #include <libcamera/camera.h>
> +
> +#include <iomanip>
> +
>  #include <libcamera/request.h>
>  #include <libcamera/stream.h>
>
> diff --git a/src/libcamera/camera_manager.cpp b/src/libcamera/camera_manager.cpp
> index e2473816b252..58d3b0ddb8bb 100644
> --- a/src/libcamera/camera_manager.cpp
> +++ b/src/libcamera/camera_manager.cpp
> @@ -5,8 +5,9 @@
>   * camera_manager.h - Camera management
>   */
>
> -#include <libcamera/camera.h>
>  #include <libcamera/camera_manager.h>
> +
> +#include <libcamera/camera.h>
>  #include <libcamera/event_dispatcher.h>
>
>  #include "device_enumerator.h"
> diff --git a/src/libcamera/camera_sensor.cpp b/src/libcamera/camera_sensor.cpp
> index 52bd8f6fb973..8f2eab562b94 100644
> --- a/src/libcamera/camera_sensor.cpp
> +++ b/src/libcamera/camera_sensor.cpp
> @@ -5,13 +5,14 @@
>   * camera_sensor.cpp - A camera sensor
>   */
>
> +#include "camera_sensor.h"
> +
>  #include <algorithm>
>  #include <float.h>
>  #include <iomanip>
>  #include <limits.h>
>  #include <math.h>
>
> -#include "camera_sensor.h"
>  #include "formats.h"
>  #include "v4l2_subdevice.h"
>
> diff --git a/src/libcamera/device_enumerator.cpp b/src/libcamera/device_enumerator.cpp
> index e7de415b7139..f3f26d98b65e 100644
> --- a/src/libcamera/device_enumerator.cpp
> +++ b/src/libcamera/device_enumerator.cpp
> @@ -5,6 +5,8 @@
>   * device_enumerator.cpp - Enumeration and matching
>   */
>
> +#include "device_enumerator.h"
> +
>  #include <fcntl.h>
>  #include <libudev.h>
>  #include <string.h>
> @@ -13,7 +15,6 @@
>
>  #include <libcamera/event_notifier.h>
>
> -#include "device_enumerator.h"
>  #include "log.h"
>  #include "media_device.h"
>  #include "utils.h"
> diff --git a/src/libcamera/event_dispatcher_poll.cpp b/src/libcamera/event_dispatcher_poll.cpp
> index a2674ab31135..130b5e20ea09 100644
> --- a/src/libcamera/event_dispatcher_poll.cpp
> +++ b/src/libcamera/event_dispatcher_poll.cpp
> @@ -5,6 +5,8 @@
>   * event_dispatcher_poll.cpp - Poll-based event dispatcher
>   */
>
> +#include "event_dispatcher_poll.h"
> +
>  #include <algorithm>
>  #include <iomanip>
>  #include <poll.h>
> @@ -16,7 +18,6 @@
>  #include <libcamera/event_notifier.h>
>  #include <libcamera/timer.h>
>
> -#include "event_dispatcher_poll.h"
>  #include "log.h"
>
>  /**
> diff --git a/src/libcamera/event_notifier.cpp b/src/libcamera/event_notifier.cpp
> index 0f84e4128169..b32c7ed2d315 100644
> --- a/src/libcamera/event_notifier.cpp
> +++ b/src/libcamera/event_notifier.cpp
> @@ -5,9 +5,10 @@
>   * event_notifier.cpp - File descriptor event notifier
>   */
>
> +#include <libcamera/event_notifier.h>
> +
>  #include <libcamera/camera_manager.h>
>  #include <libcamera/event_dispatcher.h>
> -#include <libcamera/event_notifier.h>
>
>  /**
>   * \file event_notifier.h
> diff --git a/src/libcamera/geometry.cpp b/src/libcamera/geometry.cpp
> index a39b85e4e904..c8aa05f54b73 100644
> --- a/src/libcamera/geometry.cpp
> +++ b/src/libcamera/geometry.cpp
> @@ -5,11 +5,11 @@
>   * geometry.cpp - Geometry-related structures
>   */
>
> +#include <libcamera/geometry.h>
> +
>  #include <sstream>
>  #include <stdint.h>
>
> -#include <libcamera/geometry.h>
> -
>  /**
>   * \file geometry.h
>   * \brief Data structures related to geometric objects
> diff --git a/src/libcamera/include/device_enumerator.h b/src/libcamera/include/device_enumerator.h
> index 22ed8dedcb06..2801861864b8 100644
> --- a/src/libcamera/include/device_enumerator.h
> +++ b/src/libcamera/include/device_enumerator.h
> @@ -14,6 +14,9 @@
>
>  #include <linux/media.h>
>
> +struct udev;
> +struct udev_monitor;
> +
>  namespace libcamera {
>
>  class EventNotifier;
> diff --git a/src/libcamera/include/event_dispatcher_poll.h b/src/libcamera/include/event_dispatcher_poll.h
> index 1c0066c24dc8..14c3eea13b5e 100644
> --- a/src/libcamera/include/event_dispatcher_poll.h
> +++ b/src/libcamera/include/event_dispatcher_poll.h
> @@ -13,6 +13,8 @@
>  #include <map>
>  #include <vector>
>
> +struct pollfd;
> +
>  namespace libcamera {
>
>  class EventNotifier;
> diff --git a/src/libcamera/include/pipeline_handler.h b/src/libcamera/include/pipeline_handler.h
> index a0862ebf35df..c3f7d4c29205 100644
> --- a/src/libcamera/include/pipeline_handler.h
> +++ b/src/libcamera/include/pipeline_handler.h
> @@ -10,6 +10,7 @@
>  #include <list>
>  #include <map>
>  #include <memory>
> +#include <set>
>  #include <string>
>  #include <vector>
>
> diff --git a/src/libcamera/log.cpp b/src/libcamera/log.cpp
> index 77927ec35b62..ebf553300f5b 100644
> --- a/src/libcamera/log.cpp
> +++ b/src/libcamera/log.cpp
> @@ -5,6 +5,8 @@
>   * log.cpp - Logging infrastructure
>   */
>
> +#include "log.h"
> +
>  #include <cstdio>
>  #include <cstdlib>
>  #include <ctime>
> @@ -15,7 +17,6 @@
>  #include <string.h>
>  #include <unordered_set>
>
> -#include "log.h"
>  #include "utils.h"
>
>  /**
> diff --git a/src/libcamera/media_device.cpp b/src/libcamera/media_device.cpp
> index 9c438ce8b41f..449571fb4b78 100644
> --- a/src/libcamera/media_device.cpp
> +++ b/src/libcamera/media_device.cpp
> @@ -5,6 +5,8 @@
>   * media_device.cpp - Media device handler
>   */
>
> +#include "media_device.h"
> +
>  #include <errno.h>
>  #include <fcntl.h>
>  #include <string.h>
> @@ -17,7 +19,6 @@
>  #include <linux/media.h>
>
>  #include "log.h"
> -#include "media_device.h"
>
>  /**
>   * \file media_device.h
> diff --git a/src/libcamera/media_object.cpp b/src/libcamera/media_object.cpp
> index bbb8fb64465f..8794ff4578c9 100644
> --- a/src/libcamera/media_object.cpp
> +++ b/src/libcamera/media_object.cpp
> @@ -5,6 +5,8 @@
>   * media_object.cpp - Media device objects: entities, pads and links
>   */
>
> +#include "media_object.h"
> +
>  #include <errno.h>
>  #include <string.h>
>  #include <unistd.h>
> @@ -16,7 +18,6 @@
>
>  #include "log.h"
>  #include "media_device.h"
> -#include "media_object.h"
>
>  /**
>   * \file media_object.h
> diff --git a/src/libcamera/object.cpp b/src/libcamera/object.cpp
> index 826eed6f9b3a..a504ca2c9daf 100644
> --- a/src/libcamera/object.cpp
> +++ b/src/libcamera/object.cpp
> @@ -6,6 +6,7 @@
>   */
>
>  #include <libcamera/object.h>
> +
>  #include <libcamera/signal.h>
>
>  /**
> diff --git a/src/libcamera/pipeline_handler.cpp b/src/libcamera/pipeline_handler.cpp
> index f7a8a1ac3be6..345abca89ab8 100644
> --- a/src/libcamera/pipeline_handler.cpp
> +++ b/src/libcamera/pipeline_handler.cpp
> @@ -5,13 +5,14 @@
>   * pipeline_handler.cpp - Pipeline handler infrastructure
>   */
>
> +#include "pipeline_handler.h"
> +
>  #include <libcamera/buffer.h>
>  #include <libcamera/camera.h>
>  #include <libcamera/camera_manager.h>
>
>  #include "log.h"
>  #include "media_device.h"
> -#include "pipeline_handler.h"
>  #include "utils.h"
>
>  /**
> diff --git a/src/libcamera/request.cpp b/src/libcamera/request.cpp
> index ef65c42f9da7..fa3ee46da440 100644
> --- a/src/libcamera/request.cpp
> +++ b/src/libcamera/request.cpp
> @@ -5,11 +5,12 @@
>   * request.cpp - Capture request handling
>   */
>
> +#include <libcamera/request.h>
> +
>  #include <map>
>
>  #include <libcamera/buffer.h>
>  #include <libcamera/camera.h>
> -#include <libcamera/request.h>
>  #include <libcamera/stream.h>
>
>  #include "log.h"
> diff --git a/src/libcamera/signal.cpp b/src/libcamera/signal.cpp
> index f97d68b3e8bf..4cb85ecb0686 100644
> --- a/src/libcamera/signal.cpp
> +++ b/src/libcamera/signal.cpp
> @@ -5,6 +5,8 @@
>   * signal.cpp - Signal & slot implementation
>   */
>
> +#include <libcamera/signal.h>
> +
>  /**
>   * \file signal.h
>   * \brief Signal & slot implementation
> diff --git a/src/libcamera/stream.cpp b/src/libcamera/stream.cpp
> index 06db9797ff7e..0fd0a86e780d 100644
> --- a/src/libcamera/stream.cpp
> +++ b/src/libcamera/stream.cpp
> @@ -5,11 +5,11 @@
>   * stream.cpp - Video stream for a Camera
>   */
>
> +#include <libcamera/stream.h>
> +
>  #include <iomanip>
>  #include <sstream>
>
> -#include <libcamera/stream.h>
> -
>  /**
>   * \file stream.h
>   * \brief Video stream for a Camera
> diff --git a/src/libcamera/timer.cpp b/src/libcamera/timer.cpp
> index f42e479b996e..1cce45085c61 100644
> --- a/src/libcamera/timer.cpp
> +++ b/src/libcamera/timer.cpp
> @@ -5,11 +5,12 @@
>   * timer.cpp - Generic timer
>   */
>
> +#include <libcamera/timer.h>
> +
>  #include <time.h>
>
>  #include <libcamera/camera_manager.h>
>  #include <libcamera/event_dispatcher.h>
> -#include <libcamera/timer.h>
>
>  #include "log.h"
>
> diff --git a/src/libcamera/utils.cpp b/src/libcamera/utils.cpp
> index e38f32684bb1..66123b189110 100644
> --- a/src/libcamera/utils.cpp
> +++ b/src/libcamera/utils.cpp
> @@ -5,11 +5,11 @@
>   * utils.cpp - Miscellaneous utility functions
>   */
>
> +#include "utils.h"
> +
>  #include <string.h>
>  #include <sys/auxv.h>
>
> -#include "utils.h"
> -
>  /**
>   * \file utils.h
>   * \brief Miscellaneous utility functions
> diff --git a/src/libcamera/v4l2_device.cpp b/src/libcamera/v4l2_device.cpp
> index ccc5fbfc2268..8d8c7887bf71 100644
> --- a/src/libcamera/v4l2_device.cpp
> +++ b/src/libcamera/v4l2_device.cpp
> @@ -5,6 +5,8 @@
>   * v4l2_device.cpp - V4L2 Device
>   */
>
> +#include "v4l2_device.h"
> +
>  #include <fcntl.h>
>  #include <iomanip>
>  #include <sstream>
> @@ -21,7 +23,6 @@
>  #include "log.h"
>  #include "media_device.h"
>  #include "media_object.h"
> -#include "v4l2_device.h"
>
>  /**
>   * \file v4l2_device.h
> diff --git a/src/libcamera/v4l2_subdevice.cpp b/src/libcamera/v4l2_subdevice.cpp
> index eaa673e994b9..6fc866a6450b 100644
> --- a/src/libcamera/v4l2_subdevice.cpp
> +++ b/src/libcamera/v4l2_subdevice.cpp
> @@ -5,6 +5,8 @@
>   * v4l2_subdevice.cpp - V4L2 Subdevice
>   */
>
> +#include "v4l2_subdevice.h"
> +
>  #include <fcntl.h>
>  #include <iomanip>
>  #include <sstream>
> @@ -19,7 +21,6 @@
>  #include "log.h"
>  #include "media_device.h"
>  #include "media_object.h"
> -#include "v4l2_subdevice.h"
>
>  /**
>   * \file v4l2_subdevice.h
> --
> Regards,
>
> Laurent Pinchart
>
> _______________________________________________
> libcamera-devel mailing list
> libcamera-devel@lists.libcamera.org
> https://lists.libcamera.org/listinfo/libcamera-devel