build: relative header includes, dropping -Isrc/compat and -Isrc/common

Only the generated config.h and the API headers in src/include should be
located via search path now.


git-svn-id: svn://scm.orgis.org/mpg123/trunk@5386 35dc7657-300d-0410-a2e5-dc2837fedb53

Makefile.am

@@ -31,14 +31,7 @@ XFAIL_TESTS =
 check_PROGRAMS =
 
 AM_CPPFLAGS = -DPKGLIBDIR="\"$(pkglibdir)\""
-# That can be trimmed down later when adapting the sources to
-# use relative paths for includes.
-# TODO: Actually do more relative includes.
-AM_CPPFLAGS += \
-  $(LTDLINCL) \
-  -I$(top_srcdir)/src \
-  -I$(top_srcdir)/src/compat \
-  -I$(top_srcdir)/src/common
+AM_CPPFLAGS += $(LTDLINCL)
 
 # Automake cannot handle dependencies behind an autoconf expansion.
 # So we need elaborate ifelsery here to make it see the libtool

NEWS

@@ -2,6 +2,8 @@
 ------
 - build:
 -- Reorganize shared headers, API headers into src/include.
+-- Use relative include paths, avoiding internal directories in
+   CPPFLAGS except for config.h.
 -- Group C99 feature checks and make several standard headers
    mandatory.
 -- Get rid of SIZE_P, OFF_P and friends.

ports/cmake/src/CMakeLists.txt

@@ -341,8 +341,6 @@ option(USE_NEW_HUFFTABLE "use new huffman decoding scheme by Taihei (faster on m
 include_directories(
     "${CMAKE_CURRENT_SOURCE_DIR}/../../../src/"
     "${CMAKE_CURRENT_BINARY_DIR}"
-    "${CMAKE_CURRENT_SOURCE_DIR}/../../../src/compat"
-    "${CMAKE_CURRENT_SOURCE_DIR}/../../../src/common"
     "${CMAKE_CURRENT_SOURCE_DIR}/../../../src/include")
 
 add_compile_definitions(

scripts/fixinc.pl

@@ -0,0 +1,42 @@
+#!/usr/bin/perl
+
+use File::Basename qw(dirname);
+use File::Spec::Functions qw(abs2rel);
+
+my @incdirs = ('src/common', 'src/compat', 'src');
+
+sub header
+{
+	my ($from, $inc) = @_;
+	for(dirname($from), @incdirs)
+	{
+		my $cand = "$_/$inc";
+		return $cand if -e $cand;
+	}
+	return undef;
+}
+
+for my $f (@ARGV)
+{
+	open(my $ih, '<', $f) or die "meh: $!\n";
+	open(my $oh, '>', "$f.tmp") or die "moh: $!\n";
+	while(my $line = <$ih>)
+	{
+		if($line =~ m,^(\s*\#\s*include\s+)"([^/]+)\"(.*)$,)
+		{
+			my ($pre, $inc, $post) = ($1, $2, $3);
+			my $h = header($f, $inc);
+			if($inc ne "config.h" and defined $h)
+			{
+				if(dirname($h) ne dirname($f))
+				{
+					my $rel = abs2rel($h, dirname($f));
+					print "$f: including $inc ($rel)\n";
+					$line = $pre.'"'.$rel.'"'.$post."\n";
+				}
+			}
+		}
+		print $oh "$line";
+	}
+	rename("$f.tmp", $f);
+}

src/audio.c

@@ -40,7 +40,7 @@
 #include <sys/wait.h>
 #endif
 
-#include "debug.h"
+#include "common/debug.h"
 
 static syn123_handle *sh = NULL;
 static struct mpg123_fmt outfmt = { .encoding=0, .rate=0, .channels=0 };

src/audio.h

@@ -16,7 +16,7 @@
 #ifndef _MPG123_AUDIO_H_
 #define _MPG123_AUDIO_H_
 
-#include "compat.h"
+#include "compat/compat.h"
 #include "mpg123.h"
 #include "out123.h"
 

src/common.c

@@ -18,7 +18,7 @@
 #include "terms.h"
 #include "metaprint.h"
 
-#include "debug.h"
+#include "common/debug.h"
 
 enum player_state playstate = STATE_PLAYING;
 const char playsym[STATE_COUNT] = { '>', '_', '=', '?' };

src/compat/compat.c

@@ -39,7 +39,7 @@
 #include <shlwapi.h>
 #endif
 
-#include "debug.h"
+#include "../common/debug.h"
 
 #ifndef WINDOWS_UWP
 

src/compat/compat.h

@@ -279,7 +279,7 @@ size_t INT123_unintr_fwrite(const void *ptr, size_t size, size_t nmemb, FILE *st
 #define normal mpg123_normal
 #endif
 
-#include "true.h"
+#include "../common/true.h"
 
 #if (!defined(WIN32) || defined (__CYGWIN__)) && defined(HAVE_SIGNAL_H)
 void (*INT123_catchsignal(int signum, void(*handler)(int)))(int);

src/compat/compat_dl.c

@@ -47,7 +47,7 @@
 #  endif
 #endif
 
-#include "debug.h"
+#include "../common/debug.h"
 
 #include "wpathconv.h"
 

src/compat/compat_str.c

@@ -26,7 +26,7 @@
 #include <locale.h>
 #endif
 
-#include "debug.h"
+#include "../common/debug.h"
 
 /* A safe realloc also for very old systems where realloc(NULL, size) returns NULL. */
 void *INT123_safe_realloc(void *ptr, size_t size)

src/control_generic.c

@@ -21,7 +21,7 @@
 #ifndef _BSD_SOURCE
 #define _BSD_SOURCE
 #endif
-#include "compat.h"
+#include "compat/compat.h"
 
 #include "mpg123app.h"
 #include "out123.h"
@@ -60,7 +60,7 @@ static int mode = MODE_STOPPED;
 static int init = 0;
 static int sendstat_disabled = FALSE;
 
-#include "debug.h"
+#include "common/debug.h"
 
 void generic_sendmsg (const char *fmt, ...)
 {

src/equalizer.c

@@ -7,7 +7,7 @@
 */
 
 #include "mpg123app.h"
-#include "debug.h"
+#include "common/debug.h"
 
 /* Load the settings from the path in the global variable equalfile.
    If there is no file, restore equalizer defaults. 

src/filters.c

@@ -9,7 +9,7 @@
 #include "filters.h"
 #include <ctype.h>
 
-#include "debug.h"
+#include "common/debug.h"
 
 // Validate syntax of filter specification, returning the number
 // of configured filters.

src/filters.h

@@ -19,7 +19,7 @@
 #ifndef MPG123_FILTERS_H
 #define MPG123_FILTERS_H
 
-#include "compat.h"
+#include "compat/compat.h"
 
 struct filter
 {

src/getlopt.c

@@ -8,9 +8,9 @@
 */
 
 #include "config.h"
-#include "compat.h"
+#include "compat/compat.h"
 #include "getlopt.h"
-#include "debug.h"
+#include "common/debug.h"
 
 int loptind = 1;	/* index in argv[] */
 int loptchr = 0;	/* index in argv[loptind] */

src/httpget.c

@@ -34,12 +34,12 @@
 #include "resolver.h"
 
 #include <errno.h>
-#include "true.h"
+#include "common/true.h"
 #endif
 
 #include <ctype.h>
 
-#include "debug.h"
+#include "common/debug.h"
 
 void httpdata_init(struct httpdata *e)
 {

src/libmpg123/calctables.c

@@ -12,7 +12,7 @@
 
 #define CALCTABLES
 #include "mpg123lib_intern.h"
-#include "debug.h"
+#include "../common/debug.h"
 
 #define ASIZE(a) (sizeof(a)/sizeof(*a))
 

src/libmpg123/dither_impl.h

@@ -7,7 +7,7 @@
 */
 
 #include "config.h"
-#include "compat.h"
+#include "../compat/compat.h"
 #include "dither.h"
 
 static const uint32_t init_seed = 2463534242UL;

src/libmpg123/format.c

@@ -26,8 +26,8 @@
 */
 
 #include "mpg123lib_intern.h"
-#include "sample.h"
-#include "debug.h"
+#include "../common/sample.h"
+#include "../common/debug.h"
 
 /* static int chans[NUM_CHANNELS] = { 1 , 2 }; */
 static const long my_rates[MPG123_RATES] = /* only the standard rates */
@@ -686,7 +686,7 @@ static void conv_s16_to_s32(struct outbuffer *buf)
 #endif
 #endif
 
-#include "swap_bytes_impl.h"
+#include "../common/swap_bytes_impl.h"
 
 void swap_endian(struct outbuffer *buf, int block)
 {

src/libmpg123/frame.c

@@ -9,7 +9,7 @@
 #define WANT_GETCPUFLAGS
 #include "mpg123lib_intern.h"
 #include "getcpuflags.h"
-#include "debug.h"
+#include "../common/debug.h"
 
 static void frame_fixed_reset(mpg123_handle *fr);
 

src/libmpg123/gapless.h

@@ -7,7 +7,7 @@
 	This is no stand-alone header, precisely to be able to fool it into using fake handle types for testing the math.
 */
 
-#include "debug.h"
+#include "../common/debug.h"
 
 #ifdef GAPLESS
 /* From internal sample number to external. */

src/libmpg123/getbits.h

@@ -13,7 +13,7 @@
 #define _MPG123_GETBITS_H_
 
 #include "mpg123lib_intern.h"
-#include "debug.h"
+#include "../common/debug.h"
 
 #define backbits(fr,nob) ((void)( \
   fr->bits_avail  += nob, \

src/libmpg123/icy.h

@@ -10,7 +10,7 @@
 
 #ifndef NO_ICY
 
-#include "compat.h"
+#include "../compat/compat.h"
 #include "mpg123.h"
 
 struct icy_meta

src/libmpg123/icy2utf8.c

@@ -28,7 +28,7 @@
 
 #include "config.h"
 /* Includes string and stdlib headers... */
-#include "compat.h"
+#include "../compat/compat.h"
 
 /* ThOr: too lazy for this type check; also we use char/short all around anyway.
    Of cource, it would be the proper way to use _these_ kind of types all around. */

src/libmpg123/id3.c

@@ -85,7 +85,7 @@
 
 #include "mpg123lib_intern.h"
 #include "id3.h"
-#include "debug.h"
+#include "../common/debug.h"
 
 #ifndef NO_ID3V2 /* Only the main parsing routine will always be there. */
 

src/libmpg123/index.c

@@ -8,7 +8,7 @@
 */
 
 #include "index.h"
-#include "debug.h"
+#include "../common/debug.h"
 
 /* The next expected frame offset, one step ahead. */
 static int64_t fi_next(struct frame_index *fi)

src/libmpg123/index.h

@@ -21,7 +21,7 @@
 */
 
 #include "config.h"
-#include "compat.h"
+#include "../compat/compat.h"
 
 struct frame_index
 {

src/libmpg123/layer1.c

@@ -10,7 +10,7 @@
 
 #include "mpg123lib_intern.h"
 #include "getbits.h"
-#include "debug.h"
+#include "../common/debug.h"
 
 /*
 	Allocation value is not allowed to be 15. Initially, libmad showed me the

src/libmpg123/layer3.c

@@ -21,7 +21,7 @@
 #include "huffman.h"
 #endif
 #include "getbits.h"
-#include "debug.h"
+#include "../common/debug.h"
 
 
 

src/libmpg123/lfs_wrap.c

@@ -32,16 +32,16 @@
 #endif
 
 // For correct MPG123_EXPORT.
-#include "abi_align.h"
+#include "../common/abi_align.h"
 
 // Need the full header with non-portable API, for the bare mpg123_open*()
 // declarations. But no renaming shenanigans.
 #define MPG123_NO_LARGENAME
 #include "mpg123.h"
 
 #include "lfs_wrap.h"
-#include "abi_align.h"
-#include "compat.h"
+#include "../common/abi_align.h"
+#include "../compat/compat.h"
 #include <sys/stat.h>
 #include <fcntl.h>
 
@@ -61,7 +61,7 @@
 // A paranoid check that someone did not define a wrong SIZEOF_OFF_T at configure time.
 typedef unsigned char MPG123_STATIC_ASSERT[(SIZEOF_OFF_T == sizeof(off_t)) ? 1 : -1];
 
-#include "debug.h"
+#include "../common/debug.h"
 
 // We do not want to expose this publicly, but it is cleaner to have it also defined
 // as portable API to offer the legacy function wrapper over. It's an undocumented

src/libmpg123/libmpg123.c

@@ -7,19 +7,19 @@
 */
 
 #include "mpg123lib_intern.h"
-#include "version.h"
+#include "../version.h"
 #include "icy2utf8.h"
 
 #include "gapless.h"
 /* Want accurate rounding function regardless of decoder setup. */
 #define FORCE_ACCURATE
-#include "sample.h"
+#include "../common/sample.h"
 #include "parse.h"
 #ifndef PORTABLE_API
 #include "lfs_wrap.h"
 #endif
 
-#include "debug.h"
+#include "../common/debug.h"
 
 #define SEEKFRAME(mh) ((mh)->ignoreframe < 0 ? 0 : (mh)->ignoreframe)