From: Zachary T Welch <zw@superlucidity.net>
Date: Sat, 14 Nov 2009 15:29:16 +0000 (-0800)
Subject: add openocd.h for top-level declarations
X-Git-Tag: v0.4.0-rc1~606
X-Git-Url: https://review.openocd.org/gitweb?p=openocd.git;a=commitdiff_plain;h=4088b1e622cff0673f2859de5ee611da736bdba7;hp=ab3bdfb2cb7b0c16800195951e4ee549cf8e86a5

add openocd.h for top-level declarations

Create src/openocd.h to hold declarations previously made internally
by src/main.c and src/server/server.c.  This ensures all functions
are verified to be in-sync at compile time (rather than at link),
making it easier to track down bugs.
---

diff --git a/src/Makefile.am b/src/Makefile.am
index 7721f34010..77ae5ae2e7 100644
--- a/src/Makefile.am
+++ b/src/Makefile.am
@@ -16,6 +16,10 @@ libopenocd_la_SOURCES = \
 	hello.c \
 	openocd.c
 
+noinst_HEADERS = \
+	openocd.h
+
+
 # set the include path found by configure
 AM_CPPFLAGS = \
 	-I$(top_srcdir)/src \
diff --git a/src/ecosboard.c b/src/ecosboard.c
index 38f32525ab..e38316cb7f 100644
--- a/src/ecosboard.c
+++ b/src/ecosboard.c
@@ -36,6 +36,7 @@
 #include "server.h"
 #include "telnet_server.h"
 #include "gdb_server.h"
+#include "openocd.h"
 
 #include <time_support.h>
 #include <sys/time.h>
diff --git a/src/main.c b/src/main.c
index c2b53da6e3..a71977daf9 100644
--- a/src/main.c
+++ b/src/main.c
@@ -22,6 +22,7 @@
 #ifdef HAVE_CONFIG_H
 #include "config.h"
 #endif
+#include "openocd.h"
 
 /* This is the main entry for developer PC hosted OpenOCD.
  *
@@ -32,8 +33,6 @@
  * Those applications will have their own main() implementation
  * and use bits and pieces from openocd.c. */
 
-extern int openocd_main(int argc, char *argv[]);
-
 int main(int argc, char *argv[])
 {
 	return openocd_main(argc, argv);
diff --git a/src/openocd.h b/src/openocd.h
new file mode 100644
index 0000000000..1bf6b7e6f1
--- /dev/null
+++ b/src/openocd.h
@@ -0,0 +1,39 @@
+/***************************************************************************
+ *   Copyright (C) 2005 by Dominic Rath <Dominic.Rath@gmx.de>              *
+ *   Copyright (C) 2009 by Zachary T Welch <zw@superlucidity.net>          *
+ *                                                                         *
+ *   This program 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.                                   *
+ *                                                                         *
+ *   This program 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 this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+
+#ifndef OPENOCD_H
+#define OPENOCD_H
+
+/** 
+ * Different applications can define this entry point to override
+ * the default openocd main function.  On most systems, this will be
+ * defined in src/openocd.c.
+ * @param argc normally passed from main()
+ * @param argv normally passed from main()
+ * @returns return code for main()
+ */
+int openocd_main(int argc, char *argv[]);
+
+/// used by the server_loop() function in src/server/server.c
+void openocd_sleep_prelude(void);
+/// used by the server_loop() function in src/server/server.c
+void openocd_sleep_postlude(void);
+
+#endif
diff --git a/src/server/Makefile.am b/src/server/Makefile.am
index 2f07007579..6e52fdfb88 100644
--- a/src/server/Makefile.am
+++ b/src/server/Makefile.am
@@ -1,4 +1,5 @@
 AM_CPPFLAGS = \
+	-I$(top_srcdir)/src \
 	-I$(top_srcdir)/src/helper \
 	-I$(top_srcdir)/src/target \
 	-I$(top_srcdir)/src/flash \
diff --git a/src/server/server.c b/src/server/server.c
index 7416784c76..92292eb59b 100644
--- a/src/server/server.c
+++ b/src/server/server.c
@@ -29,6 +29,7 @@
 
 #include "server.h"
 #include "target.h"
+#include "openocd.h"
 
 #include <signal.h>
 
@@ -285,9 +286,6 @@ int remove_services(void)
 	return ERROR_OK;
 }
 
-extern void openocd_sleep_prelude(void);
-extern void openocd_sleep_postlude(void);
-
 int server_loop(struct command_context *command_context)
 {
 	struct service *service;