sergiotarxz/nuttx-apps
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Header file clean-up

Browse Source 
git-svn-id: svn://svn.code.sf.net/p/nuttx/code/trunk@4948 42af7a65-404d-4744-a932-0658087f49c3
This commit is contained in:
patacongo 2012-07-17 03:58:11 +00:00
parent 3d935c341c
commit a1f980bc9d
17 changed files with 140 additions and 90 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
ChangeLog.txt
View File

@ -250,3 +250,4 @@
6.21 2012-xx-xx Gregory Nutt <gnutt@nuttx.org>
* include/: Stylistic clean-up of all header files.

17
include/apps.h
View File

@ -1,5 +1,5 @@
/****************************************************************************
* include/apps/apps.h
* apps/include/apps.h
*
* Copyright(C) 2011 Uros Platise. All rights reserved.
* Author: Uros Platise <uros.platise@isotel.eu>
@ -33,8 +33,8 @@
*
****************************************************************************/
#ifndef __INCLUDE_APPS_APPS_H
#define __INCLUDE_APPS_APPS_H
#ifndef __APPS_INCLUDE_APPS_H
#define __APPS_INCLUDE_APPS_H
/****************************************************************************
* Included Files
@ -54,10 +54,10 @@
struct namedapp_s
{
const char *name; /* Invocation name and as seen under /sbin/ */
int priority; /* Use: SCHED_PRIORITY_DEFAULT */
int stacksize; /* Desired stack size */
main_t main; /* Entry point: main(int argc, char *argv[]) */
const char *name; /* Invocation name and as seen under /sbin/ */
int priority; /* Use: SCHED_PRIORITY_DEFAULT */
int stacksize; /* Desired stack size */
main_t main; /* Entry point: main(int argc, char *argv[]) */
};
/****************************************************************************
@ -145,4 +145,5 @@ EXTERN int exec_namedapp(FAR const char *appname, FAR const char **argv);
#if defined(__cplusplus)
}
#endif
#endif /* __INCLUDE_APPS_APPS_H */
#endif /* __APPS_INCLUDE_APPS_H */

3
include/ftpc.h
View File

@ -2,7 +2,7 @@
* apps/include/ftpc.h
*
* Copyright (C) 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@ -221,4 +221,5 @@ EXTERN FAR char *ftpc_response(SESSION handle);
#ifdef __cplusplus
}
#endif
#endif /* __APPS_INCLUDE_FTPC_H */

10
include/netutils/dhcpc.h
View File

@ -1,8 +1,8 @@
/****************************************************************************
* apps/netutils/dhcpc.n
* apps/include/netutils/dhcpc.h
*
* Copyright (C) 2007, 2009-2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* This logic was leveraged from uIP which also has a BSD-style license:
*
@ -35,8 +35,8 @@
* SUCH DAMAGE.
*/
#ifndef __APPS_NETUTILS_DHCPC_H
#define __APPS_NETUTILS_DHCPC_H
#ifndef __APPS_INCLUDE_NETUTILS_DHCPC_H
#define __APPS_INCLUDE_NETUTILS_DHCPC_H
/****************************************************************************
* Included Files
@ -82,4 +82,4 @@ EXTERN void dhcpc_close(void *handle);
}
#endif
#endif /* __APPS_NETUTILS_DHCPC_H */
#endif /* __APPS_INCLUDE_NETUTILS_DHCPC_H */

10
include/netutils/dhcpd.h
View File

@ -1,8 +1,8 @@
/****************************************************************************
* apps/netutils/dhcpd.h
* apps/include/netutils/dhcpd.h
*
* Copyright (C) 2007, 2009, 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* This logic was leveraged from uIP which also has a BSD-style license:
*
@ -35,8 +35,8 @@
* SUCH DAMAGE.
*/
#ifndef __APPS_NETUTILS_DHCPD_H
#define __APPS_NETUTILS_DHCPD_H
#ifndef __APPS_INCLUDE_NETUTILS_DHCPD_H
#define __APPS_INCLUDE_NETUTILS_DHCPD_H
/****************************************************************************
* Included Files
@ -68,4 +68,4 @@ EXTERN int dhcpd_run(void);
}
#endif
#endif /* __APPS_NETUTILS_DHCPD_H */
#endif /* __APPS_INCLUDE_NETUTILS_DHCPD_H */

26
include/netutils/httpd.h
View File

@ -1,8 +1,8 @@
/****************************************************************************
* apps/netutils/httpd.h
* apps/include/netutils/httpd.h
*
* Copyright (C) 2007, 2009, 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Based on uIP which also has a BSD style license:
*
@ -37,8 +37,8 @@
*
****************************************************************************/
#ifndef __APPS_NETUTILS_HTTPD_H
#define __APPS_NETUTILS_HTTPD_H
#ifndef __APPS_INCLUDE_NETUTILS_HTTPD_H
#define __APPS_INCLUDE_NETUTILS_HTTPD_H
/****************************************************************************
* Included Files
@ -48,7 +48,19 @@
* Public Function Prototypes
****************************************************************************/
extern void httpd_init(void);
extern int httpd_listen(void);
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
#endif /* __APPS_NETUTILS_HTTPD_H */
EXTERN void httpd_init(void);
EXTERN int httpd_listen(void);
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __APPS_INCLUDE_NETUTILS_HTTPD_H */

10
include/netutils/ipmsfilter.h
View File

@ -1,9 +1,9 @@
/****************************************************************************
* apps/netutils/ipmsfilter.h
* apps/include/netutils/ipmsfilter.h
* User interface to add/remove IP multicast address
*
* Copyright (C) 2009, 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@ -34,8 +34,8 @@
*
****************************************************************************/
#ifndef __APPS_NETUTILS_IPMSFILTER_H
#define __APPS_NETUTILS_IPMSFILTER_H
#ifndef __APPS_INCLUDE_NETUTILS_IPMSFILTER_H
#define __APPS_INCLUDE_NETUTILS_IPMSFILTER_H
/****************************************************************************
* Included Files
@ -98,4 +98,4 @@ EXTERN int ipmsfilter(FAR const char *ifname,
#endif
#endif /* CONFIG_NET_IGMP */
#endif /* __APPS_NETUTILS_IPMSFILTER_H */
#endif /* __APPS_INCLUDE_NETUTILS_IPMSFILTER_H */

22
include/netutils/resolv.h
View File

@ -1,6 +1,7 @@
/* includes/apps/netutils/resolv.h
/****************************************************************************
* apps/include/netutils/resolv.h
* DNS resolver code header file.
* Authtor Adam Dunkels <adam@dunkels.com>
* Author Adam Dunkels <adam@dunkels.com>
*
* Copyright (c) 2002-2003, Adam Dunkels.
* All rights reserved.
@ -28,13 +29,22 @@
* WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
*
****************************************************************************/
#ifndef __APPS_NETUTILS_RESOLVE_H
#define __APPS_NETUTILS_RESOLVE_H
#ifndef __APPS_INCLUDE_NETUTILS_RESOLVE_H
#define __APPS_INCLUDE_NETUTILS_RESOLVE_H
/****************************************************************************
* Included Files
****************************************************************************/
#include <nuttx/net/uip/uipopt.h>
/****************************************************************************
* Public Function Prototypes
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
@ -62,4 +72,4 @@ EXTERN int resolv_query(const char *name, struct sockaddr_in *addr);
}
#endif
#endif /* __APPS_NETUTILS_RESOLVE_H */
#endif /* __APPS_INCLUDE_NETUTILS_RESOLVE_H */

30
include/netutils/smtp.h
View File

@ -1,9 +1,9 @@
/****************************************************************************
* include/apps/netutils/smtp.h
* apps/include/netutils/smtp.h
* SMTP header file
*
* Copyright (C) 2007, 2009, 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Heavily leveraged from uIP 1.0 which also has a BSD-like license:
*
@ -37,8 +37,8 @@
*
****************************************************************************/
#ifndef __APPS_NETUTILS_SMTP_H
#define __APPS_NETUTILS_SMTP_H
#ifndef __APPS_INCLUDE_NETUTILS_SMTP_H
#define __APPS_INCLUDE_NETUTILS_SMTP_H
/****************************************************************************
* Included Files
@ -55,12 +55,24 @@
* Public Function Prototypes
****************************************************************************/
extern void *smtp_open(void);
extern void smtp_configure(void *handle, const char *localhostname,
#ifdef __cplusplus
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
EXTERN void *smtp_open(void);
EXTERN void smtp_configure(void *handle, const char *localhostname,
const uip_ipaddr_t *paddr);
extern int smtp_send(void *handle, const char *to, const char *cc,
EXTERN int smtp_send(void *handle, const char *to, const char *cc,
const char *from, const char *subject,
const char *msg, int msglen);
extern void smtp_close(void *handle);
EXTERN void smtp_close(void *handle);
#endif /* __APPS_NETUTILS_SMTP_H */
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __APPS_INCLUDE_NETUTILS_SMTP_H */

2
include/netutils/telnetd.h
View File

@ -1,5 +1,5 @@
/****************************************************************************
* include/apps/netutils/telnetd.h
* apps/include/netutils/telnetd.h
*
* Copyright (C) 2007, 2011-2012 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>

10
include/netutils/tftp.h
View File

@ -1,8 +1,8 @@
/****************************************************************************
* include/apps/netutils/tftp.h
* apps/include/netutils/tftp.h
*
* Copyright (C) 2008-2009, 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@ -33,8 +33,8 @@
*
****************************************************************************/
#ifndef __APPS_NETUTILS_TFTP_H
#define __APPS_NETUTILS_TFTP_H
#ifndef __APPS_INCLUDE_NETUTILS_TFTP_H
#define __APPS_INCLUDE_NETUTILS_TFTP_H
/****************************************************************************
* Included Files
@ -70,4 +70,4 @@ EXTERN int tftpput(const char *local, const char *remote, in_addr_t addr, bool b
}
#endif
#endif /* __APPS_NETUTILS_TFTP_H */
#endif /* __APPS_INCLUDE_NETUTILS_TFTP_H */

10
include/netutils/thttpd.h
View File

@ -1,8 +1,8 @@
/****************************************************************************
* apps/netutils/thttpd.h
* apps/include/netutils/thttpd.h
*
* Copyright (C) 2009, 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@ -33,8 +33,8 @@
*
****************************************************************************/
#ifndef __APPS_NETUTILS_THTTPD_H
#define __APPS_NETUTILS_THTTPD_H
#ifndef __APPS_INCLUDE_NETUTILS_THTTPD_H
#define __APPS_INCLUDE_NETUTILS_THTTPD_H
/****************************************************************************
* Included Files
@ -98,4 +98,4 @@ EXTERN int thttpd_main(int argc, char **argv);
}
#endif
#endif /* __APPS_NETUTILS_THTTPD_H */
#endif /* __APPS_INCLUDE_NETUTILS_THTTPD_H */

49
include/netutils/uiplib.h
View File

@ -1,10 +1,10 @@
/****************************************************************************
* apps/netutils/uiplib.h
* apps/include/netutils/uiplib.h
* Various non-standard APIs to support netutils. All non-standard and
* intended only for internal use.
*
* Copyright (C) 2007, 2009, 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Some of these APIs derive from uIP but all of them use the uip_ prefix
* to identify them as members of this library. uIP also has a BSD style
@ -42,8 +42,8 @@
*
****************************************************************************/
#ifndef __APPS_NETUTILS_UIPLIB_H
#define __APPS_NETUTILS_UIPLIB_H
#ifndef __APPS_INCLUDE_NETUTILS_UIPLIB_H
#define __APPS_INCLUDE_NETUTILS_UIPLIB_H
/****************************************************************************
* Included Files
@ -77,6 +77,14 @@
* Public Function Prototypes
****************************************************************************/
#undef EXTERN
#if defined(__cplusplus)
#define EXTERN extern "C"
extern "C" {
#else
#define EXTERN extern
#endif
/* Convert a textual representation of an IP address to a numerical representation.
*
* This function takes a textual representation of an IP address in
@ -93,37 +101,42 @@
* Return: Non-zero If the IP address was parsed.
*/
extern bool uiplib_ipaddrconv(const char *addrstr, uint8_t *addr);
EXTERN bool uiplib_ipaddrconv(const char *addrstr, uint8_t *addr);
/* Get and set IP/MAC addresses (Ethernet L2 only) */
#ifdef CONFIG_NET_ETHERNET
extern int uip_setmacaddr(const char *ifname, const uint8_t *macaddr);
extern int uip_getmacaddr(const char *ifname, uint8_t *macaddr);
EXTERN int uip_setmacaddr(const char *ifname, const uint8_t *macaddr);
EXTERN int uip_getmacaddr(const char *ifname, uint8_t *macaddr);
#endif
/* IP address support */
#ifdef CONFIG_NET_IPv6
extern int uip_gethostaddr(const char *ifname, struct in6_addr *addr);
extern int uip_sethostaddr(const char *ifname, const struct in6_addr *addr);
extern int uip_setdraddr(const char *ifname, const struct in6_addr *addr);
extern int uip_setnetmask(const char *ifname, const struct in6_addr *addr);
EXTERN int uip_gethostaddr(const char *ifname, struct in6_addr *addr);
EXTERN int uip_sethostaddr(const char *ifname, const struct in6_addr *addr);
EXTERN int uip_setdraddr(const char *ifname, const struct in6_addr *addr);
EXTERN int uip_setnetmask(const char *ifname, const struct in6_addr *addr);
#else
extern int uip_gethostaddr(const char *ifname, struct in_addr *addr);
extern int uip_sethostaddr(const char *ifname, const struct in_addr *addr);
extern int uip_setdraddr(const char *ifname, const struct in_addr *addr);
extern int uip_setnetmask(const char *ifname, const struct in_addr *addr);
EXTERN int uip_gethostaddr(const char *ifname, struct in_addr *addr);
EXTERN int uip_sethostaddr(const char *ifname, const struct in_addr *addr);
EXTERN int uip_setdraddr(const char *ifname, const struct in_addr *addr);
EXTERN int uip_setnetmask(const char *ifname, const struct in_addr *addr);
#endif
/* HTTP support */
extern int uip_parsehttpurl(const char *url, uint16_t *port,
EXTERN int uip_parsehttpurl(const char *url, uint16_t *port,
char *hostname, int hostlen,
char *filename, int namelen);
/* Generic server logic */
extern void uip_server(uint16_t portno, pthread_startroutine_t handler, int stacksize);
EXTERN void uip_server(uint16_t portno, pthread_startroutine_t handler, int stacksize);
#endif /* __APPS_NETUTILS_UIPLIB_H */
#undef EXTERN
#ifdef __cplusplus
}
#endif
#endif /* __APPS_INCLUDE_NETUTILS_UIPLIB_H */

10
include/netutils/webclient.h
View File

@ -1,9 +1,9 @@
/****************************************************************************
* include/apps/netutils/webclient.h
* apps/include/netutils/webclient.h
* Header file for the HTTP client
*
* Copyright (C) 2007, 2009, 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Based remotely on the uIP webclient which also has a BSD style license:
*
@ -39,8 +39,8 @@
*
****************************************************************************/
#ifndef __APPS_NETUTILS_WEBCLIENT_H
#define __APPS_NETUTILS_WEBCLIENT_H
#ifndef __APPS_INCLUDE_NETUTILS_WEBCLIENT_H
#define __APPS_INCLUDE_NETUTILS_WEBCLIENT_H
/****************************************************************************
* Included Files
@ -146,4 +146,4 @@ EXTERN int wget(FAR const char *url, FAR char *buffer, int buflen,
}
#endif
#endif /* __APPS_NETUTILS_WEBCLIENT_H */
#endif /* __APPS_INCLUDE_NETUTILS_WEBCLIENT_H */

10
include/nsh.h
View File

@ -1,8 +1,8 @@
/****************************************************************************
* include/apps/nsh.h
* apps/include/nsh.h
*
* Copyright (C) 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
@ -33,8 +33,8 @@
*
****************************************************************************/
#ifndef __INCLUDE_APPS_NSHLIB_H
#define __INCLUDE_APPS_NSHLIB_H
#ifndef __APPS_INCLUDE_NSH_H
#define __APPS_INCLUDE_NSH_H
/****************************************************************************
* Included Files
@ -118,4 +118,4 @@ EXTERN int nsh_telnetstart(void);
}
#endif
#endif /* __INCLUDE_APPS_NSHLIB_H */
#endif /* __APPS_INCLUDE_NSH_H */

8
include/readline.h
View File

@ -1,5 +1,5 @@
/****************************************************************************
* include/apps/readline.h
* apps/include/readline.h
*
* Copyright (C) 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <gnutt@nuttx.org>
@ -33,8 +33,8 @@
*
****************************************************************************/
#ifndef __INCLUDE_APPS_READLINE_H
#define __INCLUDE_APPS_READLINE_H
#ifndef __APPS_INCLUDE_READLINE_H
#define __APPS_INCLUDE_READLINE_H
/****************************************************************************
* Included Files
@ -97,4 +97,4 @@ EXTERN ssize_t readline(FAR char *buf, int buflen, FILE *instream, FILE *outstre
}
#endif
#endif /* __INCLUDE_APPS_READLINE_H */
#endif /* __APPS_INCLUDE_READLINE_H */

2
include/tiff.h
View File

@ -2,7 +2,7 @@
* apps/include/tiff.h
*
* Copyright (C) 2011 Gregory Nutt. All rights reserved.
* Author: Gregory Nutt <spudmonkey@racsa.co.cr>
* Author: Gregory Nutt <gnutt@nuttx.org>
*
* Reference:
* "TIFF, Revision 6.0, Final," June 3, 1992, Adobe Developers Association.