diff options
| author | Paul Corner <paul_c@users.sourceforge.net> | 2004-06-12 11:49:45 +0000 |
|---|---|---|
| committer | Paul Corner <paul_c@users.sourceforge.net> | 2004-06-12 11:49:45 +0000 |
| commit | 59f4eef60f76d7729a7f0d2f3de270ab44bad365 (patch) | |
| tree | 30a38552f0fefbf8b9b0524e336129cf31fd8bc7 | |
| parent | f8e06490e0160bfe23e8a28a36d4b317f8ac8a7f (diff) | |
| download | linuxcnc-59f4eef60f76d7729a7f0d2f3de270ab44bad365.tar.gz linuxcnc-59f4eef60f76d7729a7f0d2f3de270ab44bad365.zip | |
Added GPL headers to all the libnml sources
86 files changed, 1608 insertions, 565 deletions
diff --git a/src/libnml/buffer/locmem.cc b/src/libnml/buffer/locmem.cc index 1a10b3338..d7b9ce670 100644 --- a/src/libnml/buffer/locmem.cc +++ b/src/libnml/buffer/locmem.cc @@ -1,11 +1,25 @@ -/************************************************************************ -File: locmem.cc -Purpose: Implements LOCMEM which is a derived class of CMS that serves primarily -to provide addresses that match when matching buffer names are passed to -the constructor. It is useful in allowing control modules to use the -same inteface to communicate as would be required if they were not -running in the same process even though to use LOCMEM they must be. -**********************************************************************/ +/******************************************************************** +* Description: locmem.cc +* Implements LOCMEM which is a derived class of CMS that serves +* primarily to provide addresses that match when matching buffer +* names are passed to the constructor. It is useful in allowing +* control modules to use the same inteface to communicate as would +* be required if they were not running in the same process even +* though to use LOCMEM they must be. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "locmem.hh" // class LOCMEM #include "cms.hh" // class CMS diff --git a/src/libnml/buffer/locmem.hh b/src/libnml/buffer/locmem.hh index d8ef85316..160da9923 100644 --- a/src/libnml/buffer/locmem.hh +++ b/src/libnml/buffer/locmem.hh @@ -1,11 +1,25 @@ -/************************************************************************ -File: locmem.hh -Purpose: Defines LOCMEM which is a derived class of CMS that serves primarily -to provide addresses that match when matching buffer names are passed to -the constructor. It is useful in allowing control modules to use the -same inteface to communicate as would be required if they were not -running in the same process even though to use LOCMEM they must be. -**********************************************************************/ +/******************************************************************** +* Description: locmem.hh +* Implements LOCMEM which is a derived class of CMS that serves +* primarily to provide addresses that match when matching buffer +* names are passed to the constructor. It is useful in allowing +* control modules to use the same inteface to communicate as would +* be required if they were not running in the same process even +* though to use LOCMEM they must be. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef LOCMEM_HH #define LOCMEM_HH diff --git a/src/libnml/buffer/memsem.cc b/src/libnml/buffer/memsem.cc index a540db447..22c1be23c 100644 --- a/src/libnml/buffer/memsem.cc +++ b/src/libnml/buffer/memsem.cc @@ -1,27 +1,31 @@ -/********************************************************************** -* File: memsem.cc -* Purpose: Uses a block of memory to implement a mutual exclusion semaphore. -* With LynxOs and SunOs using semop is very inefficient if the semaphore will -* ussually be available. Other platforms may give you no semaphore operations. +/******************************************************************** +* Description: memsem.cc +* Uses a block of memory to implement a mutual exclusion semaphore. +* With LynxOs and SunOs using semop is very inefficient if the semaphore +* will usually be available. Other platforms may give you no semaphore +* operations. * -* Example: You are communicating with another process via shared memory. You -* need a mutual exclusion semaphore because you don't want the reader to -* occasionally read the buffer while the writer has written only part of the -* message, but most of the time when the writer won't be using buffer and -* the reader should get access immediately. semop will take 100 to 150 -* microseconds to return access, while mem_get_access should take less than -* a microsecond with less than 10 total_connections. +* Example: You are communicating with another process via shared memory. +* You need a mutual exclusion semaphore because you don't want the reader +* to occasionally read the buffer while the writer has written only part +* of the message, but most of the time when the writer won't be using +* buffer and the reader should get access immediately. semop will take +* 100 to 150 microseconds to return access, while mem_get_access should +* take less than a microsecond with less than 10 total_connections. * -* On 1/23/95 Will Shackleford began additions to allow for the buffer to -* be split. Splitting the buffer between doubles the ammount of memory -* required, but means that readers will never have to wait for a semaphore -* and decreases the percentage of time a writer will have to wait. +* Derived from a work by Fred Proctor & Will Shackleford * -* This code will be obsolete when all operating systems provide efficient -* semaphore functions and all microprocessors have effective test and -* set instructions. -*************************************************************************/ - +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/buffer/memsem.hh b/src/libnml/buffer/memsem.hh index 3765127da..13d612b93 100644 --- a/src/libnml/buffer/memsem.hh +++ b/src/libnml/buffer/memsem.hh @@ -1,11 +1,21 @@ -/********************************************************************** -* File: memsem.hh -* Purpose: Provides function prototypes that let programmers -* use a block of memory to implement a mutual exclusion semaphore. +/******************************************************************** +* Description: memsem.hh +* Provides function prototypes that let programmers use a block of +* memory to implement a mutual exclusion semaphore. * -* With LynxOs and SunOs using semop is very inefficient if the semaphore will -* ussually be available. Other platforms may give you no semaphore operations. -*************************************************************************/ +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef MEMSEM_HH #define MEMSEM_HH diff --git a/src/libnml/buffer/phantom.cc b/src/libnml/buffer/phantom.cc index 1078ec5d2..771ee7cff 100644 --- a/src/libnml/buffer/phantom.cc +++ b/src/libnml/buffer/phantom.cc @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: phantom.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "cms.hh" /* enum CMS_STATUS */ #include "phantom.hh" /* class PHANTOMMEM */ diff --git a/src/libnml/buffer/phantom.hh b/src/libnml/buffer/phantom.hh index d1422cc7f..b4394ff3f 100644 --- a/src/libnml/buffer/phantom.hh +++ b/src/libnml/buffer/phantom.hh @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: phantom.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef PHANTOM_HH #define PHANTOM_HH diff --git a/src/libnml/buffer/physmem.cc b/src/libnml/buffer/physmem.cc index 796d82a03..4af7eb7a1 100644 --- a/src/libnml/buffer/physmem.cc +++ b/src/libnml/buffer/physmem.cc @@ -1,16 +1,21 @@ -/*********************************************************************** -* File: physmem.cc -* Purpose: Provides the member functions for the PHYSMEM_HANDLE class. This is -* a C++ interface for portable access to physical memory. -* NOTES: -* On some platforms accessing a block of physical memory is a simple as -* intitializing a pointer and then dereferencing it, but accessing specific -* sections of extended memory under DOS or Windows requires changing the -* descriptor tables and therefore circumventing protected mode security. -* Other platforms require the use of mmap() on memory device files to choose -* a section of memory mapped IO. -***********************************************************************/ - +/******************************************************************** +* Description: physmem.cc +* Provides the member functions for the PHYSMEM_HANDLE class. This +* is a C++ interface for portable access to physical memory. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/buffer/physmem.hh b/src/libnml/buffer/physmem.hh index b5fcae608..d8896bd47 100644 --- a/src/libnml/buffer/physmem.hh +++ b/src/libnml/buffer/physmem.hh @@ -1,15 +1,21 @@ -/*********************************************************************** -* File: physmem.hh -* Purpose: Define the PHYSMEM_HANDLE class which creates objects that represent -* a portable interface to sections of physical memory. -* NOTES: -* On some platforms accessing a block of physical memory is a simple as -* intitializing a pointer and then dereferencing it, but accessing specific -* sections of extended memory under DOS or Windows requires changing the -* descriptor tables and therefore circumventing protected mode security. -* Other platforms require the use of mmap on memory device files to choose -* a section of memory mapped IO. -***********************************************************************/ +/******************************************************************** +* Description: physmem.hh +* Provides the member functions for the PHYSMEM_HANDLE class. This +* is a C++ interface for portable access to physical memory. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef PHYSMEM_HH #define PHYSMEM_HH diff --git a/src/libnml/buffer/recvn.c b/src/libnml/buffer/recvn.c index 51829c593..393139f2a 100644 --- a/src/libnml/buffer/recvn.c +++ b/src/libnml/buffer/recvn.c @@ -1,15 +1,28 @@ -/************************************************************************ -* File: recvn.c -* Purpose: Provides a C file for the recvn function from -* the book Advanced Programming in the UNIX Environment by Richard Stevens. -* The recvn function calls the recv function repeatedly until n bytes -* have been recv from the file descriptor. -* It uses select and FIONREAD checks ahead of time to guarantee that even -* if the socket is blocking the timeout will be enforced. -* To retry a socket to for the data missed during past timeouts the -* application should pass recvn the same buffer and address of a variable -* storing the number of bytes read on previous attempts. -*************************************************************************/ +/******************************************************************** +* Description: recvn.c +* Provides a C file for the recvn function from the book Advanced +* Programming in the UNIX Environment by Richard Stevens. +* The recvn function is called repeatedly until n bytes have been +* received from the file descriptor. It uses select and FIONREAD +* checks ahead of time to guarantee that even if the socket is +* blocking the timeout will be enforced. To retry a socket to for +* the data missed during past timeouts the application should pass +* recvn the same buffer and address of a variable storing the number +* of bytes read on previous attempts. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "recvn.h" /* recvn(int, void *, int, double) */ #include <stddef.h> /* size_t */ diff --git a/src/libnml/buffer/recvn.h b/src/libnml/buffer/recvn.h index fa57ffe70..251325c98 100644 --- a/src/libnml/buffer/recvn.h +++ b/src/libnml/buffer/recvn.h @@ -1,10 +1,23 @@ -/************************************************************************ -* File: recvn.h -* Purpose: Provides a header file for the recvn function from -* the book Advanced Programming in the UNIX Environment by Richard Stevens. -* The writen function calls the recv function repeatedly until n bytes -* have been recv from the file descriptor. -*************************************************************************/ +/******************************************************************** +* Description: recvn.c +* Provides a C file for the recvn function from the book Advanced +* Programming in the UNIX Environment by Richard Stevens. +* The function is called repeatedly until n bytes have been received +* from the file descriptor. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef RECVN_H #define RECVN_H diff --git a/src/libnml/buffer/rem_msg.hh b/src/libnml/buffer/rem_msg.hh index c811d5c8e..66345f420 100644 --- a/src/libnml/buffer/rem_msg.hh +++ b/src/libnml/buffer/rem_msg.hh @@ -1,16 +1,26 @@ -/*************************************************************** -* File: rem_msg.hh -* Purpose: Defines the structs passed between REMOTE clients and servers -* as part of CMS. -* Includes: -* 1. struct REMOTE_READ_REQUEST, REMOTE_READ_REPLY, -* REMOTE_WRITE_REPLY, REMOTE_WRITE_REQUEST. -* 2. Function prototypes for functions that XDR encode and decode these -* structs. -* NOTES: -* In windows, these XDR functions need to use the Pascal calling convention -* so that the PC-NFS Toolkit DLL can call them. -*****************************************************************/ +/******************************************************************** +* Description: rem_msg.hh +* Defines the structs passed between REMOTE clients and servers +* as part of CMS. +* Includes: +* 1. struct REMOTE_READ_REQUEST, REMOTE_READ_REPLY, +* REMOTE_WRITE_REPLY, REMOTE_WRITE_REQUEST. +* 2. Function prototypes for functions that XDR encode and decode these +* structs. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef REM_MSG_HH #define REM_MSG_HH diff --git a/src/libnml/buffer/sendn.c b/src/libnml/buffer/sendn.c index 63c319846..587e3988e 100644 --- a/src/libnml/buffer/sendn.c +++ b/src/libnml/buffer/sendn.c @@ -1,10 +1,23 @@ -/************************************************************************ -* File: sendn.c -* Purpose: Provides a C file for the sendn function from -* the book Advanced Programming in the UNIX Environment by Richard Stevens. -* The sendn function calls the send function repeatedly until n bytes -* have been written to the file descriptor. -*************************************************************************/ +/******************************************************************** +* Description: sendn.c +* Provides a C file for the sendn function from the book Advanced +* Programming in the UNIX Environment by Richard Stevens. +* The sendn function calls the send function repeatedly until n bytes +* have been written to the file descriptor. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include <string.h> /* strerror */ #include <stdlib.h> /* memset() */ diff --git a/src/libnml/buffer/sendn.h b/src/libnml/buffer/sendn.h index 3704bbdfe..cee60f6b4 100644 --- a/src/libnml/buffer/sendn.h +++ b/src/libnml/buffer/sendn.h @@ -1,10 +1,23 @@ -/************************************************************************ -* File: sendn.h -* Purpose: Provides a header file for the sendn function from -* the book Advanced Programming in the UNIX Environment by Richard Stevens. -* The sendn function calls the send function repeatedly until n bytes -* have been written to the file descriptor. -*************************************************************************/ +/******************************************************************** +* Description: sendn.h +* Provides a C file for the sendn function from the book Advanced +* Programming in the UNIX Environment by Richard Stevens. +* The sendn function calls the send function repeatedly until n bytes +* have been written to the file descriptor. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef WRITEN_H #define WRITEN_H diff --git a/src/libnml/buffer/shmem.cc b/src/libnml/buffer/shmem.cc index b8911e759..90e09df33 100644 --- a/src/libnml/buffer/shmem.cc +++ b/src/libnml/buffer/shmem.cc @@ -1,16 +1,23 @@ -/************************************************************************* -* File: shmem.cc * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ file for the Communication Management System (CMS). * -* Includes: * -* 1. Member Functions for class SHMEM. * -* Notes: The class SHMEM should be used by procedures accessing a shared * -* memory buffer on the same processor. * -* The RCS_SEMAPHORE is no longer used. Instead a section of the shared * -* memory buffer itself is used to guarantee mutual exclusion. * -*************************************************************************/ - -/* Include Files */ +/******************************************************************** +* Description: shmem.cc +* C++ file for the Communication Management System (CMS). +* Includes member Functions for class SHMEM. +* Notes: The class SHMEM should be used by procedures accessing a +* shared memory buffer on the same processor. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/buffer/shmem.hh b/src/libnml/buffer/shmem.hh index 561168407..ef51f5912 100644 --- a/src/libnml/buffer/shmem.hh +++ b/src/libnml/buffer/shmem.hh @@ -1,18 +1,27 @@ -/************************************************************************* -* File: shmem.hh * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ Header file for the Communication Management System (CMS).* -* Includes: * -* 1. class SHMEM. * -* Notes: The class SHMEM should be used by procedures accessing a shared * -* memory buffer on the same processor. * -*************************************************************************/ +/******************************************************************** +* Description: shmem.hh +* C++ file for the Communication Management System (CMS). +* Includes member Functions for class SHMEM. +* Notes: The class SHMEM should be used by procedures accessing a +* shared memory buffer on the same processor. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef SHMEM_HH #define SHMEM_HH -/* Include Files */ - #ifdef __cplusplus extern "C" { #endif @@ -27,13 +36,13 @@ extern "C" { #include "cms.hh" /* class CMS */ #include "shm.hh" /* class RCS_SHAREDMEM */ #include "memsem.hh" /* struct mem_access_object */ -// #include "sem.hh" /* class RCS_SEMAPHORE *//* Class Definitions */ - class SHMEM:public CMS { + +class SHMEM:public CMS { public: SHMEM(char *name, long size, int neutral, key_t key, int m = 0); - SHMEM(char *bufline, char *procline, int set_to_server = 0, + SHMEM(char *bufline, char *procline, int set_to_server = 0, int set_to_master = 0); - virtual ~ SHMEM(); + virtual ~ SHMEM(); CMS_STATUS main_access(void *_local); diff --git a/src/libnml/buffer/tcpmem.cc b/src/libnml/buffer/tcpmem.cc index 591081668..65680a100 100644 --- a/src/libnml/buffer/tcpmem.cc +++ b/src/libnml/buffer/tcpmem.cc @@ -1,4 +1,19 @@ - +/******************************************************************** +* Description: tcpmem.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/buffer/tcpmem.hh b/src/libnml/buffer/tcpmem.hh index cd2afb521..b2bb18a9f 100644 --- a/src/libnml/buffer/tcpmem.hh +++ b/src/libnml/buffer/tcpmem.hh @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: tcpmem.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef TCPMEM_HH #define TCPMEM_HH diff --git a/src/libnml/cms/cms.cc b/src/libnml/cms/cms.cc index eedb835b1..54dafd636 100644 --- a/src/libnml/cms/cms.cc +++ b/src/libnml/cms/cms.cc @@ -1,17 +1,23 @@ -/************************************************************************* -* File: cms.cc -* Authors: Fred Proctor, Will Shackleford -* Purpose: C++ file for the Communication Management System (CMS). -* Includes: -* 1. Member functions for class CMS. -* NOTES: -* See cms_in.cc for the internal interface member functions and cms_up.cc -* for the update functions. -*************************************************************************/ - -/* SCCS identification. (Used by what. See UNIX man pages section 1.) */ - -/* Include Files */ +/******************************************************************** +* Description: cms.cc +* C++ file for the Communication Management System (CMS). +* Includes member functions for class CMS. +* See cms_in.cc for the internal interface member functions and +* cms_up.cc for the update functions. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "rcsversion.h" diff --git a/src/libnml/cms/cms.hh b/src/libnml/cms/cms.hh index 4c5634272..dbf75f5d3 100644 --- a/src/libnml/cms/cms.hh +++ b/src/libnml/cms/cms.hh @@ -1,20 +1,24 @@ -/************************************************************************* -* File: cms.hh * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ Header file for the Communication Management System (CMS).* -* Includes: * -* 1. class CMS. * -* 2. class CMS_UPDATER * -* 2. enum CMS_STATUS. * -* 3. enum CMSMODE. * -* 4. enum CMSBUFFERTYPE. * -* 5. enum CMSPROCESSTYPE. * -*************************************************************************/ +/******************************************************************** +* Description: cms.hh +* C++ Header file for the Communication Management System (CMS). +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef CMS_HH #define CMS_HH -/* Include Files */ #ifdef __cplusplus extern "C" { #endif diff --git a/src/libnml/cms/cms_aup.cc b/src/libnml/cms/cms_aup.cc index 81e63e3cf..24af838ae 100644 --- a/src/libnml/cms/cms_aup.cc +++ b/src/libnml/cms/cms_aup.cc @@ -1,16 +1,27 @@ -/*************************************************************************** -* File: cms_aup.cc -* Author(s): Will Shackleford, Fred Proctor -* Purpose: Provides the interface to CMS used by NML update functions including -* a CMS update function for all the basic C data types to convert NMLmsgs to XDR. +/******************************************************************** +* Description: cms_aup.cc +* Provides the interface to CMS used by NML update functions +* including a CMS update function for all the basic C data types +* to convert NMLmsgs to XDR. +* NOTES: There are no update functions for enumerations, or pointers. +* The update function for long doubles is included, but it is +* recommended that doubles be used instead of long doubles since they +* will be faster and the increased range and precision of long doubles +* will be lost anyway. * -* NOTES: -* There are no update functions for enumerations, or pointers. -* The update function for long doubles is included, but it is recommended that -* doubles be used instead of long doubles since they will be faster and -* the increased range and precision of long doubles will be lost anyway. -****************************************************************************/ - +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/cms/cms_aup.hh b/src/libnml/cms/cms_aup.hh index 259194865..1c92491d5 100644 --- a/src/libnml/cms/cms_aup.hh +++ b/src/libnml/cms/cms_aup.hh @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: cms_aup.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef CMS_AUP_HH #define CMS_AUP_HH diff --git a/src/libnml/cms/cms_cfg.cc b/src/libnml/cms/cms_cfg.cc index efc5f0713..1516374c8 100644 --- a/src/libnml/cms/cms_cfg.cc +++ b/src/libnml/cms/cms_cfg.cc @@ -1,14 +1,21 @@ -/************************************************************************* -* File: cms_cfg.cc * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ file for the Communication Management System (CMS). * -* Includes: * -* 1. cms_config -- CMS function which reads -* configuration file. * -*************************************************************************/ - -/* Include Files */ - +/******************************************************************** +* Description: cms_cfg.cc +* C++ file for the Communication Management System (CMS). +* Provides cms_config -- CMS function which reads configuration file. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ extern int verbose_nml_error_messages; diff --git a/src/libnml/cms/cms_cfg.hh b/src/libnml/cms/cms_cfg.hh index 6fd30c0b3..af324361d 100644 --- a/src/libnml/cms/cms_cfg.hh +++ b/src/libnml/cms/cms_cfg.hh @@ -1,17 +1,24 @@ -/************************************************************************* -* File: cms_cfg.hh * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ Header file for the Communication Management System (CMS)* -* Includes: * -* 1. cms_config -- function which reads * -* configuration file. * -*************************************************************************/ +/******************************************************************** +* Description: cms_cfg.hh +* cms_config -- function which reads configuration file. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef CMS_CFG_HH #define CMS_CFG_HH -/* Include Files */ - #include "cms_user.hh" /* Config File Definitions. */ diff --git a/src/libnml/cms/cms_dup.cc b/src/libnml/cms/cms_dup.cc index 0aaa2b876..b58a1d86d 100644 --- a/src/libnml/cms/cms_dup.cc +++ b/src/libnml/cms/cms_dup.cc @@ -1,16 +1,22 @@ -/*************************************************************************** -* File: cms_dup.cc -* Author(s): Will Shackleford, Fred Proctor -* Purpose: Provides the interface to CMS used by NML update functions including -* a CMS update function for all the basic C data types to convert NMLmsgs to XDR. +/******************************************************************** +* Description: cms_dup.cc +* Provides the interface to CMS used by NML update functions +* including a CMS update function for all the basic C data types +* to convert NMLmsgs to XDR. * -* NOTES: -* There are no update functions for enumerations, or pointers. -* The update function for long doubles is included, but it is recommended that -* doubles be used instead of long doubles since they will be faster and -* the increased range and precision of long doubles will be lost anyway. -****************************************************************************/ - +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/cms/cms_dup.hh b/src/libnml/cms/cms_dup.hh index cbf325973..76cf79d97 100644 --- a/src/libnml/cms/cms_dup.hh +++ b/src/libnml/cms/cms_dup.hh @@ -1,3 +1,20 @@ +/******************************************************************** +* Description: cms_dup.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef CMS_DUP_HH #define CMS_DUP_HH diff --git a/src/libnml/cms/cms_in.cc b/src/libnml/cms/cms_in.cc index 944160c04..7ddbb7c2b 100644 --- a/src/libnml/cms/cms_in.cc +++ b/src/libnml/cms/cms_in.cc @@ -1,29 +1,40 @@ -/***************************************************************************** -* File: cms_in.cc -* Author(s): Will Shackleford -* Purpose: Provides the internal interface of CMS to the buffer. +/******************************************************************** +* Description: cms_in.cc +* Provides the internal interface of CMS to the buffer. +* The following applies to the member functions in this file: +* They work through a handle to a shared physical memory object. +* They should only be called when this process has sole access to +* this shared physical memory object. This is normally achieved by +* taking a mutual-exclusion semaphore before calling the +* internal_access function above from the main_access function +* of a derived class. +* If they begin with "queue" then they are for buffers where messages +* are to be queued, other wise they are for buffers with will have +* only one message at a time. +* Queuing buffers store a CMS_QUEUING_HEADER at the beginning and a +* CMS_HEADER before each message. Non-queuing buffers have only a +* CMS_HEADER before the only message. +* If they end in "encoded" they are for buffers that will neutrally +* encoded in some processor architecture independant data format such +* as XDR (eXternal Data Representation), otherwise the buffer must be +* in the format used by the same compiler as this is compiled in and +* for the same processor architecture and the function name will end +* in "raw". * -* NOTES: -* The following applies to the member functions in this file: -* They work through a handle to a shared physical memory object. -* They should only be called when this process has sole access to - this shared physical memory object. This is normally achieved by taking - a mutual-exclusion semaphore before calling the internal_access function - above from the main_access function of a derived class. -* If they begin with "queue" then they are for buffers where messages are - to be queued, other wise they are for buffers with will have only 1 - message at a time.* -* Queuing buffers store a CMS_QUEUING_HEADER at the beginning and a - CMS_HEADER before each message. Non-queuing buffers have only a - CMS_HEADER before the only message. -* If they end in "encoded" they are for buffers that will neutrally encoded - in some processor architecture independant data format such as XDR - (eXternal Data Representation), otherwise the buffer must be in the - format used by the same compiler as this is compiled in and for the same - processor architecture and the function name will end in "raw". -*****************************************************************************/ - -/* Include Files */ +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #include "cms.hh" /* class CMS */ #include "cmsdiag.hh" // class CMS_DIAG_PROC_INFO, CMS_DIAG_HEADER #include "rcs_print.hh" /* rcs_print_error() */ diff --git a/src/libnml/cms/cms_pm.cc b/src/libnml/cms/cms_pm.cc index 8056ddd73..a388806eb 100644 --- a/src/libnml/cms/cms_pm.cc +++ b/src/libnml/cms/cms_pm.cc @@ -1,7 +1,20 @@ -/************************************************************************** -* File: cms_pm.cc * -* Provides CMS update functions for the POSEMATH classes. * -**************************************************************************/ +/******************************************************************** +* Description: cms_pm.cc +* Provides CMS update functions for the POSEMATH classes.* +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "cms.hh" // class CMS #include "posemath.h" // POSEMATH classes diff --git a/src/libnml/cms/cms_srv.cc b/src/libnml/cms/cms_srv.cc index 647d57491..d1f1e0c3d 100644 --- a/src/libnml/cms/cms_srv.cc +++ b/src/libnml/cms/cms_srv.cc @@ -1,14 +1,20 @@ -/************************************************************************* -* File:cms_srv.cc * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ file for RPC server that reads and writes to a local * -* CMS buffer for remote processes. * -* Includes: * -* 1. member functions for class CMS_SERVER * -* 2. CMS_SERVER friend functions cms_server_dispatch and * -* cms_server_clean. * -*************************************************************************/ - +/******************************************************************** +* Description: cms_srv.cc +* Server to read and write to a local CMS buffer for remote processes. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { @@ -23,9 +29,7 @@ extern "C" { #include <sys/types.h> #include <unistd.h> /* getpid() */ #include <sys/wait.h> /* waitpid() */ - -#include <signal.h> /* sigvec(), struct sigvec, SIGINT */ - /* kill() */ +#include <signal.h> /* sigvec(), struct sigvec, SIGINT, kill() */ #ifdef __cplusplus } diff --git a/src/libnml/cms/cms_srv.hh b/src/libnml/cms/cms_srv.hh index 5f23fba69..8a1516dbd 100644 --- a/src/libnml/cms/cms_srv.hh +++ b/src/libnml/cms/cms_srv.hh @@ -1,8 +1,25 @@ +/******************************************************************** +* Description: cms_srv.hh +* C++ Header file for server that reads and writes to a local CMS +* buffer for remote processes. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ /************************************************************************* * File:cms_srv.hh * Authors: Fred Proctor, Will Shackleford -* Purpose: C++ Header file for server that reads and writes -* to a local CMS buffer for remote processes. +* Purpose: * Includes: * 1. class CMS_SERVER * 2. class CMS_SERVER_LOCAL_PORT diff --git a/src/libnml/cms/cms_up.cc b/src/libnml/cms/cms_up.cc index 7b47f0249..7a07d9325 100644 --- a/src/libnml/cms/cms_up.cc +++ b/src/libnml/cms/cms_up.cc @@ -1,14 +1,22 @@ -/*************************************************************************** -* File: cms_up.cc -* Author(s): Will Shackleford, Fred Proctor -* Purpose: Provides the interface to CMS used by NML update functions including -* a CMS update function for all the basic C data types. +/******************************************************************** +* Description: cms_up.cc +* Provides the interface to CMS used by NML update functions +* including a CMS update function for all the basic C data types. * -* NOTES: -* There are no update functions for enumerations, or pointers. -****************************************************************************/ +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ -/* Includes */ #include "cms.hh" /* class CMS */ #include "cms_up.hh" /* class CMS_UPDATER */ #include "rcs_print.hh" /* rcs_print_error() */ @@ -21,6 +29,7 @@ extern "C" { #ifdef __cplusplus } #endif + CMS_UPDATER::CMS_UPDATER(CMS * _cms_parent, int create_encoded_data, long _neutral_size_factor): /********************************************** diff --git a/src/libnml/cms/cms_up.hh b/src/libnml/cms/cms_up.hh index 129fee83e..fb6e4a583 100644 --- a/src/libnml/cms/cms_up.hh +++ b/src/libnml/cms/cms_up.hh @@ -1,10 +1,23 @@ -/************************************************************************** -* File: cms_up.hh -* This C++ header file defines the abstract CMS_UPDATER class that defines the -* interface used by CMS to convert between local machine-specific data -* representations and network machine-independant represantations such as XDR -* via the derived classes of CMS_UPDATER. -***************************************************************************/ +/******************************************************************** +* Description: cms_up.hh +* This C++ header file defines the abstract CMS_UPDATER class +* that defines the interface used by CMS to convert between local +* machine-specific data representations and network machine-independant +* represantations such as XDR via the derived classes of CMS_UPDATER. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef CMS_UP_HH #define CMS_UP_HH diff --git a/src/libnml/cms/cms_user.hh b/src/libnml/cms/cms_user.hh index d03fcc37c..8dbb079ad 100644 --- a/src/libnml/cms/cms_user.hh +++ b/src/libnml/cms/cms_user.hh @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: cms_user.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef CMS_USER_HH #define CMS_USER_HH diff --git a/src/libnml/cms/cms_xup.cc b/src/libnml/cms/cms_xup.cc index efb53e285..5ab51f9a9 100644 --- a/src/libnml/cms/cms_xup.cc +++ b/src/libnml/cms/cms_xup.cc @@ -1,17 +1,23 @@ -/*************************************************************************** -* File: cms_xup.cc -* Author(s): Will Shackleford, Fred Proctor -* Purpose: Provides the interface to CMS used by NML update functions including -* a CMS update function for all the basic C data types to convert NMLmsgs to XDR. +/******************************************************************** +* Description: cms_xup.cc +* Provides the interface to CMS used by NML update functions +* including a CMS update function for all the basic C data types +* to convert NMLmsgs to XDR. * -* NOTES: -* There are no update functions for enumerations, or pointers. -* The update function for long doubles is included, but it is recommended that -* doubles be used instead of long doubles since they will be faster and -* the increased range and precision of long doubles will be lost anyway. -****************************************************************************/ - -/* Includes */ +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + extern "C" { #include <stdlib.h> /* malloc(), free() */ } diff --git a/src/libnml/cms/cms_xup.hh b/src/libnml/cms/cms_xup.hh index b939b87c1..14c15d737 100644 --- a/src/libnml/cms/cms_xup.hh +++ b/src/libnml/cms/cms_xup.hh @@ -1,4 +1,19 @@ - +/******************************************************************** +* Description: cms_xup.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef CMS_XUP_HH #define CMS_XUP_HH diff --git a/src/libnml/cms/cmsdiag.cc b/src/libnml/cms/cmsdiag.cc index 5cb463b3f..cf131efd2 100644 --- a/src/libnml/cms/cmsdiag.cc +++ b/src/libnml/cms/cmsdiag.cc @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: cmsdiag.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "cmsdiag.hh" #include "rcsversion.h" diff --git a/src/libnml/cms/cmsdiag.hh b/src/libnml/cms/cmsdiag.hh index 1f1cf34dd..5a654410e 100644 --- a/src/libnml/cms/cmsdiag.hh +++ b/src/libnml/cms/cmsdiag.hh @@ -1,3 +1,20 @@ +/******************************************************************** +* Description: cmsdiag.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef CMSDIAG_HH #define CMSDIAG_HH diff --git a/src/libnml/cms/cmssvrp.cc b/src/libnml/cms/cmssvrp.cc index 41892ac57..ee0906f98 100644 --- a/src/libnml/cms/cmssvrp.cc +++ b/src/libnml/cms/cmssvrp.cc @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: cmssvrp.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ extern "C" void cms_print_servers(); diff --git a/src/libnml/cms/tcp_opts.cc b/src/libnml/cms/tcp_opts.cc index 273c9e4a9..82b51739b 100644 --- a/src/libnml/cms/tcp_opts.cc +++ b/src/libnml/cms/tcp_opts.cc @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: tcp_opts.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "tcp_opts.hh" #include "rcs_print.hh" /* rcs_print_error() */ diff --git a/src/libnml/cms/tcp_opts.hh b/src/libnml/cms/tcp_opts.hh index e7cc28da2..34a02978b 100644 --- a/src/libnml/cms/tcp_opts.hh +++ b/src/libnml/cms/tcp_opts.hh @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: tcp_opts.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef TCP_OPTS_HH #define TCP_OPTS_HH diff --git a/src/libnml/cms/tcp_srv.cc b/src/libnml/cms/tcp_srv.cc index b86f8236e..c696becc6 100644 --- a/src/libnml/cms/tcp_srv.cc +++ b/src/libnml/cms/tcp_srv.cc @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: tcp_srv.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ /**************************************************************************** * File: tcp_srv.cc * Purpose: Provides the functions for the class CMS_SERVER_REMOTE_TCP_PORT diff --git a/src/libnml/cms/tcp_srv.hh b/src/libnml/cms/tcp_srv.hh index 066ebad23..a60116cd4 100644 --- a/src/libnml/cms/tcp_srv.hh +++ b/src/libnml/cms/tcp_srv.hh @@ -1,3 +1,20 @@ +/******************************************************************** +* Description: tcp_srv.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef TCP_SRV_HH #define TCP_SRV_HH diff --git a/src/libnml/inifile/_inifile.c b/src/libnml/inifile/_inifile.c index 0f2393c10..abab3cfa8 100644 --- a/src/libnml/inifile/_inifile.c +++ b/src/libnml/inifile/_inifile.c @@ -1,14 +1,22 @@ -/* - _inifile.c - - C INI file reader - - Modification history: +/******************************************************************** +* Description: _inifile.c +* C INI file reader +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ - 21-Jan-2004 P.C. Moved across from the original EMC source tree. - */ #include "inifile.h" - #include <stdio.h> /* FILE *, fopen(), fclose(), NULL */ #include <string.h> /* strlen(), etc. */ #include <ctype.h> /* isspace() */ diff --git a/src/libnml/inifile/inifile.cc b/src/libnml/inifile/inifile.cc index 64ce24be7..7ba1e5e35 100644 --- a/src/libnml/inifile/inifile.cc +++ b/src/libnml/inifile/inifile.cc @@ -1,13 +1,20 @@ -/* - inifile.cc - - INI file reader - - Modification history: - - 21-Jan-2004 P.C. Moved across from the original EMC source tree. - */ - +/******************************************************************** +* Description: inifile.cc +* C++ INI file reader +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/inifile/inifile.h b/src/libnml/inifile/inifile.h index b1557f59a..128578170 100644 --- a/src/libnml/inifile/inifile.h +++ b/src/libnml/inifile/inifile.h @@ -1,13 +1,24 @@ +/******************************************************************** +* Description: inifile.h +* Declarations for INI file format functions +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef INIFILE_H #define INIFILE_H -/* - inifile.h - - Decls for INI file format functions - -*/ - #ifdef __cplusplus extern "C" { #endif diff --git a/src/libnml/inifile/inivar.c b/src/libnml/inifile/inivar.c index cc37eea03..3a285446c 100644 --- a/src/libnml/inifile/inivar.c +++ b/src/libnml/inifile/inivar.c @@ -1,19 +1,28 @@ -/* - inivar.c - - prints to stdout the INI file result of a variable-in-section search, - useful for scripts that want to pick things out of INI files. - - syntax: inivar -var <variable> {-sec <section>} {<-ini inifile>} - - Uses emc.ini as default. <variable> needs to be supplied. If <section> - is omitted, first instance of <variable> will be looked for in any section. - Otherwise only a match of the variable in <section> will be returned. - - Modification history: - - 21-Jan-2004 P.C. Moved across from the original EMC source tree. -*/ +/******************************************************************** +* Description: inivar.c +* prints to stdout the INI file result of a variable-in-section +* search, useful for scripts that want to pick things out of INI files. +* +* syntax: inivar -var <variable> {-sec <section>} {<-ini inifile>} +* +* Uses emc.ini as default. <variable> needs to be supplied. If <section> +* is omitted, first instance of <variable> will be looked for in any +* section. Otherwise only a match of the variable in <section> will +* be returned. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include <stdio.h> /* printf(), fprintf(), FILE, fopen(), fclose() */ diff --git a/src/libnml/linklist/linklist.cc b/src/libnml/linklist/linklist.cc index fd56b56fb..41e0d1a64 100644 --- a/src/libnml/linklist/linklist.cc +++ b/src/libnml/linklist/linklist.cc @@ -1,3 +1,20 @@ +/******************************************************************** +* Description: linklist.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifdef __cplusplus extern "C" { #endif diff --git a/src/libnml/linklist/linklist.hh b/src/libnml/linklist/linklist.hh index 509fc40fc..63957e04a 100644 --- a/src/libnml/linklist/linklist.hh +++ b/src/libnml/linklist/linklist.hh @@ -1,7 +1,23 @@ +/******************************************************************** +* Description: linklist.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef LINKED_LIST_HH #define LINKED_LIST_HH - #ifdef __cplusplus extern "C" { #endif diff --git a/src/libnml/nml/cmd_msg.cc b/src/libnml/nml/cmd_msg.cc index a4158a2e2..b0c78a9a3 100644 --- a/src/libnml/nml/cmd_msg.cc +++ b/src/libnml/nml/cmd_msg.cc @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: cmd_msg.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/nml/cmd_msg.hh b/src/libnml/nml/cmd_msg.hh index aa0192c87..fc8f0e575 100644 --- a/src/libnml/nml/cmd_msg.hh +++ b/src/libnml/nml/cmd_msg.hh @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: cmd_msg.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef RCS_CMD_HH #define RCS_CMD_HH diff --git a/src/libnml/nml/nml.cc b/src/libnml/nml/nml.cc index 2198efffb..cc528269b 100644 --- a/src/libnml/nml/nml.cc +++ b/src/libnml/nml/nml.cc @@ -1,12 +1,20 @@ -/************************************************************************* -* File: nml.cc * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ file for the Neutral Manufacturing Language (NML). * -* Includes: * -* 1. Member functions for class NML. * -*************************************************************************/ - -/* Include Files */ +/******************************************************************** +* Description: nml.cc +* C++ file for the Neutral Manufacturing Language (NML). +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "rcsversion.h" diff --git a/src/libnml/nml/nml.hh b/src/libnml/nml/nml.hh index cccaabfa4..d1b4f1859 100644 --- a/src/libnml/nml/nml.hh +++ b/src/libnml/nml/nml.hh @@ -1,19 +1,24 @@ -/************************************************************************* -* File: nml.hh * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ Header file for the Neutral Manufacturing Language (NML). * -* Includes: * -* 1. class NML. * -* 2. typedef for NMLTYPE. * -* 3. typedef for NML_FORMAT_PTR * -* 4. enum NML_ERROR_TYPE * -*************************************************************************/ +/******************************************************************** +* Description: nml.hh +* C++ file for the Neutral Manufacturing Language (NML). +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef NML_HH #define NML_HH -/* Include Files */ - #ifdef __cplusplus extern "C" { #endif diff --git a/src/libnml/nml/nml_oi.cc b/src/libnml/nml/nml_oi.cc index 1d1dcac8e..8825c12dc 100644 --- a/src/libnml/nml/nml_oi.cc +++ b/src/libnml/nml/nml_oi.cc @@ -1,17 +1,23 @@ -/*************************************************************** -* File: nml_oi.cc -***************************************************************/ - -/* - MODIFICATIONS: - - 29-May-1997 WPS took functions from nml_emc.cc -*/ +/******************************************************************** +* Description: nml_oi.cc +* NML operator interface messages for errors, text, and display +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "nml_oi.hh" -// NML operator interface messages for errors, text, and display - void NML_ERROR::update(CMS * cms) { diff --git a/src/libnml/nml/nml_oi.hh b/src/libnml/nml/nml_oi.hh index 72fd2fd09..672e9e50b 100644 --- a/src/libnml/nml/nml_oi.hh +++ b/src/libnml/nml/nml_oi.hh @@ -1,16 +1,21 @@ -/********************************************************************* -* File: nml_oi.hh +/******************************************************************** +* Description: nml_oi.cc +* Defines Generic NML Message structures used to log errors and +* interact with an Operator Interface from within an NML_MODULE. * -* Defines Generic NML Message structures used to log errors and interact -* with an Operator Interface from within an NML_MODULE. +* Derived from a work by Fred Proctor & Will Shackleford * -**********************************************************************/ - -/* - MODIFICATIONS: - - 29-May-1997 WPS took definitions from nml_emc.hh -*/ +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef NML_OI_HH #define NML_OI_HH diff --git a/src/libnml/nml/nml_srv.cc b/src/libnml/nml/nml_srv.cc index 6a8eec896..7ada07f6a 100644 --- a/src/libnml/nml/nml_srv.cc +++ b/src/libnml/nml/nml_srv.cc @@ -1,11 +1,19 @@ -/************************************************************************* -* File:nml_srv.cc * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ file for RPC server that reads and writes * -* to a local NML buffer for remote processes. * -* Includes: * -* 1. class NML_SERVER member functions. * -*************************************************************************/ +/******************************************************************** +* Description: nml_srv.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/nml/nml_srv.hh b/src/libnml/nml/nml_srv.hh index 25ac05c60..9f5a257e3 100644 --- a/src/libnml/nml/nml_srv.hh +++ b/src/libnml/nml/nml_srv.hh @@ -1,11 +1,19 @@ -/************************************************************************* -* File:nml_srv.hh * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ Header file for RPC server that reads and writes * -* to a local NML buffer for remote processes. * -* Includes: * -* 1. class NML_SERVER * -*************************************************************************/ +/******************************************************************** +* Description: nml_srv.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef NML_SERVER_HH #define NML_SERVER_HH diff --git a/src/libnml/nml/nmldiag.cc b/src/libnml/nml/nmldiag.cc index db7a4319e..c578cc4b7 100644 --- a/src/libnml/nml/nmldiag.cc +++ b/src/libnml/nml/nmldiag.cc @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: nmldiag.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "nml.hh" // NML_MAIN_Channel_List #include "nmldiag.hh" diff --git a/src/libnml/nml/nmldiag.hh b/src/libnml/nml/nmldiag.hh index 5ab37500a..4e5b60275 100644 --- a/src/libnml/nml/nmldiag.hh +++ b/src/libnml/nml/nmldiag.hh @@ -1,3 +1,20 @@ +/******************************************************************** +* Description: nmldiag.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef NMLDIAG_HH #define NMLDIAG_HH diff --git a/src/libnml/nml/nmlmsg.cc b/src/libnml/nml/nmlmsg.cc index 9e0355bf1..70ad39bc0 100644 --- a/src/libnml/nml/nmlmsg.cc +++ b/src/libnml/nml/nmlmsg.cc @@ -1,12 +1,19 @@ -/************************************************************************* -* File: nmlmsg.cc * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ file for the Neutral Manufacturing Language (NML). * -* Includes: * -* 1. Member functions for class NMLmsg. * -*************************************************************************/ - -/* Include Files */ +/******************************************************************** +* Description: nmlmsg.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/nml/nmlmsg.hh b/src/libnml/nml/nmlmsg.hh index 13df35433..562fe0a32 100644 --- a/src/libnml/nml/nmlmsg.hh +++ b/src/libnml/nml/nmlmsg.hh @@ -1,16 +1,23 @@ -/************************************************************************* -* File: nmlmsg.hh * -* Authors: Fred Proctor, Will Shackleford * -* Purpose: C++ Header file for the Neutral Manufacturing Language (NML). * -* Includes: * -* 1. NMLmsg Class. * -* 2. NMLTYPE typedef. * -*************************************************************************/ +/******************************************************************** +* Description: nmlmsg.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef NMLMSG_HH #define NMLMSG_HH -/* Include Files */ #ifdef __cplusplus extern "C" { #endif diff --git a/src/libnml/nml/stat_msg.cc b/src/libnml/nml/stat_msg.cc index a61b0d61d..66351df75 100644 --- a/src/libnml/nml/stat_msg.cc +++ b/src/libnml/nml/stat_msg.cc @@ -1,3 +1,20 @@ +/******************************************************************** +* Description: stat_msg.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #include "nml.hh" #include "nmlmsg.hh" #include "cms.hh" diff --git a/src/libnml/nml/stat_msg.hh b/src/libnml/nml/stat_msg.hh index 1e44517dd..5ec37218b 100644 --- a/src/libnml/nml/stat_msg.hh +++ b/src/libnml/nml/stat_msg.hh @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: stat_msg.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef RCS_STAT_HH #define RCS_STAT_HH diff --git a/src/libnml/os_intf/_sem.c b/src/libnml/os_intf/_sem.c index 16f7133a9..f6db1e79c 100644 --- a/src/libnml/os_intf/_sem.c +++ b/src/libnml/os_intf/_sem.c @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: _sem.c +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include <stdio.h> #include <stdlib.h> diff --git a/src/libnml/os_intf/_sem.h b/src/libnml/os_intf/_sem.h index 55f1c4039..9bb9da970 100644 --- a/src/libnml/os_intf/_sem.h +++ b/src/libnml/os_intf/_sem.h @@ -1,3 +1,20 @@ +/******************************************************************** +* Description: _sem.h +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef _RCS_SEMAPHORE_H #define _RCS_SEMAPHORE_H diff --git a/src/libnml/os_intf/_shm.c b/src/libnml/os_intf/_shm.c index 267e4dba3..f79c1b846 100644 --- a/src/libnml/os_intf/_shm.c +++ b/src/libnml/os_intf/_shm.c @@ -1,11 +1,20 @@ -/* - _shm.c - - C implementation of rcslib shared memory API - -*/ - -/* Unix shared memory */ +/******************************************************************** +* Description: _shm.c +* C implementation of rcslib shared memory API +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "_shm.h" #include "rcs_print.hh" diff --git a/src/libnml/os_intf/_shm.h b/src/libnml/os_intf/_shm.h index fa61469ee..556b7ae55 100644 --- a/src/libnml/os_intf/_shm.h +++ b/src/libnml/os_intf/_shm.h @@ -1,11 +1,26 @@ +/******************************************************************** +* Description: _shm.h +* Purely local shared memory functions-- converting System V +* shared memory to POSIX shared memory required something +* intermediate in System V IPC that returned a file descriptor +* suitable for mmap(), and that something doesn't exist. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef _SHAREDMEM_H #define _SHAREDMEM_H -/* Purely local shared memory functions-- converting System V shared - memory to POSIX shared memory required something intermediate in - System V IPC that returned a file descriptor suitable for mmap(), - and that something doesn't exist. */ - #include <sys/types.h> /* key_t */ #include <stddef.h> /* size_t */ diff --git a/src/libnml/os_intf/_timer.c b/src/libnml/os_intf/_timer.c index ffd2280d7..fa4d578af 100644 --- a/src/libnml/os_intf/_timer.c +++ b/src/libnml/os_intf/_timer.c @@ -1,8 +1,22 @@ -/* - timer.cc -- interval timer code. A TIMER object lets you wait on - the expiration of a cyclic period, to the resolution of the system - clock. -*/ +/******************************************************************** +* Description: _timer.c +* timer.cc -- interval timer code. A TIMER object lets you wait +* on the expiration of a cyclic period, to the resolution of the +* system clock. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "rcs_print.hh" /* rcs_print_error */ diff --git a/src/libnml/os_intf/_timer.h b/src/libnml/os_intf/_timer.h index d45a2d5c5..b015683f8 100644 --- a/src/libnml/os_intf/_timer.h +++ b/src/libnml/os_intf/_timer.h @@ -1,3 +1,22 @@ +/******************************************************************** +* Description: _timer.h +* timer.cc -- interval timer code. A TIMER object lets you wait +* on the expiration of a cyclic period, to the resolution of the +* system clock. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef _TIMER_H #define _TIMER_H diff --git a/src/libnml/os_intf/inetfile.hh b/src/libnml/os_intf/inetfile.hh index d5f375511..dc22d63bc 100644 --- a/src/libnml/os_intf/inetfile.hh +++ b/src/libnml/os_intf/inetfile.hh @@ -1,7 +1,23 @@ +/******************************************************************** +* Description: inetfile.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef INETFILE_HH #define INETFILE_HH - #ifdef __cplusplus class INET_FILE; #else diff --git a/src/libnml/os_intf/inetnull.cc b/src/libnml/os_intf/inetnull.cc index 251476509..91ef5673b 100644 --- a/src/libnml/os_intf/inetnull.cc +++ b/src/libnml/os_intf/inetnull.cc @@ -1,11 +1,23 @@ -/********************************************************************** -* FILE: inetnull.cc -* Purpose: This file provides the same set of functions as inetfile.cc -* but with local file reading capabilities only. -***********************************************************************/ +/******************************************************************** +* Description: inetnull.cc +* This file provides a set of functions to read from a local +* password file +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "inetfile.hh" - #include <stdio.h> class INET_FILE { diff --git a/src/libnml/os_intf/sem.cc b/src/libnml/os_intf/sem.cc index 64ca02d96..c9ec22062 100644 --- a/src/libnml/os_intf/sem.cc +++ b/src/libnml/os_intf/sem.cc @@ -1,11 +1,19 @@ -/* - This software was produced by the National Institute of Standards and - Technology (NIST), an agency of the U.S. government, and by statute is - not subject to copyright in the United States. Recipients of this - software assume all responsibility associated with its operation, - modification, maintenance, and subsequent redistribution. - */ - +/******************************************************************** +* Description: sem.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ extern "C" { #include <stdio.h> /* NULL */ diff --git a/src/libnml/os_intf/sem.hh b/src/libnml/os_intf/sem.hh index f62ce9f97..37382bf03 100644 --- a/src/libnml/os_intf/sem.hh +++ b/src/libnml/os_intf/sem.hh @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: sem.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef SEMAPHORE_HH #define SEMAPHORE_HH diff --git a/src/libnml/os_intf/shm.cc b/src/libnml/os_intf/shm.cc index 8e113496f..ea965c3d1 100644 --- a/src/libnml/os_intf/shm.cc +++ b/src/libnml/os_intf/shm.cc @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: shm.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "shm.hh" #include "_shm.h" /* rcs_shm_open(), rcs_shm_close() */ diff --git a/src/libnml/os_intf/shm.hh b/src/libnml/os_intf/shm.hh index 7e991c0a2..8fe37ddd1 100644 --- a/src/libnml/os_intf/shm.hh +++ b/src/libnml/os_intf/shm.hh @@ -1,7 +1,23 @@ +/******************************************************************** +* Description: shm.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef SHAREDMEM_HH #define SHAREDMEM_HH - extern "C" { #include <sys/types.h> /* key_t */ #include <stddef.h> /* size_t */ diff --git a/src/libnml/os_intf/timer.cc b/src/libnml/os_intf/timer.cc index 42de10965..867dbfb27 100644 --- a/src/libnml/os_intf/timer.cc +++ b/src/libnml/os_intf/timer.cc @@ -1,17 +1,21 @@ -/* - timer.cc -- interval timer code. A TIMER object lets you wait on - the expiration of a cyclic period, to the resolution of the system - clock. - - Ideally, we'd like to use the POSIX struct timespec, in timers.h, - for second-nanosecond resolution in real time. However, at the - moment, most OSes do not have this interface since the POSIX realtime - draft is still out. - - These functions use the BSD 'gettimeofday' interface for LynxOS and - SunOS, and the tickLib and taskLib interface on VxWorks. - */ - +/******************************************************************** +* Description: timer.cc +* A TIMER object lets you wait on the expiration of a cyclic +* period, to the resolution of the system clock. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ extern "C" { #include <stdlib.h> // atof() diff --git a/src/libnml/os_intf/timer.hh b/src/libnml/os_intf/timer.hh index 15710511a..b894de6c5 100644 --- a/src/libnml/os_intf/timer.hh +++ b/src/libnml/os_intf/timer.hh @@ -1,3 +1,21 @@ +/******************************************************************** +* Description: timer.hh +* A TIMER object lets you wait on the expiration of a cyclic +* period, to the resolution of the system clock. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef TIMER_HH #define TIMER_HH diff --git a/src/libnml/posemath/_posemath.c b/src/libnml/posemath/_posemath.c index ad2dfd5a8..288a9bbae 100644 --- a/src/libnml/posemath/_posemath.c +++ b/src/libnml/posemath/_posemath.c @@ -1,13 +1,21 @@ -/* - _posemath.c - - C definitions for pose math library data types and - manipulation functions. - - Modification history: - - 21-Jan-2004 P.C. Moved across from the original EMC source tree. -*/ +/******************************************************************** +* Description: _posemath.c +* C definitions for pose math library data types and manipulation +* functions. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include <math.h> #include <float.h> /* DBL_MAX */ diff --git a/src/libnml/posemath/posemath.cc b/src/libnml/posemath/posemath.cc index ff46bb7a2..38bc8264e 100644 --- a/src/libnml/posemath/posemath.cc +++ b/src/libnml/posemath/posemath.cc @@ -1,13 +1,21 @@ -/* - posemath.cc - - C++ definitions for pose math library data types and - manipulation functions. - - Modification history: - - 21-Jan-2004 P.C. Moved across from the original EMC source tree. -*/ +/******************************************************************** +* Description: posemath.cc +* C++ definitions for pose math library data types and manipulation +* functions. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #include "posemath.h" diff --git a/src/libnml/posemath/posemath.h b/src/libnml/posemath/posemath.h index 5beb1b9e6..7d54374ae 100644 --- a/src/libnml/posemath/posemath.h +++ b/src/libnml/posemath/posemath.h @@ -1,69 +1,79 @@ +/******************************************************************** +* Description: posemath.h +* Declarations for pose math library data types and manipulation +* functions. +* +* Data types comprise various representations of translation and +* rotation quantities, and a 'pose' for representing the location +* and orientation of a frame in space relative to a base frame. +* Translation representations include cartesian, spherical, and +* cylindrical coordinates. All of these contain 3 elements. Rotation +* representations include rotation vectors, quaternions, rotation +* matrices, Euler angles, and roll-pitch-yaw. These contain at least +* 3 elements, and may contain more. Only 3 are necessary for the 3 +* degrees of freedom for either translation or rotation, but some +* data representations use more for computational efficiency or +* intuition at the expense of storage space. +* +* Types are abbreviated in function naming with a few letters. +* Functions exist for conversion between data types, checking for +* consistency, normalization into consistency, extracting features +* such as size, and arithmetic operations. +* +* Names of data representations are in all capitals, prefixed with +* 'PM_'. Names of functions are in mixed case, prefixed with 'pm', +* with case changes used to indicate new quantities instead of +* underscores. Function syntax looks like +* int UmQuatRotConvert(PM_QUATERNION, PM_ROTATION_VECTOR *); +* +* The return value is an error code, 0 for success, or a non-zero +* error code for failure, for example: +* +* #define PM_ERR -1 +* #define PM_IMPL_ERR -2 +* +* The global variable 'pmErrno' is set to this return value. +* +* C++ classes are used for data types so that operator overloading can +* be used to reduce the programming labor. Using the overloaded operator +* version of functions loses the integer error code. The global +* variable 'pmErrno' can be queried after these operations. This is not +* thread-safe or reentrant. +* +* C++ names corresponding to the C structures use case mixing instead +* of all caps. Thus, a quaternion in C++ is a PmQuaternion. +* +* The MATH_DEBUG symbol can be defined to include error reporting via +* printed errors. +* +* Native efficient C functions exist for the PM_CARTESIAN, PM_QUATERNION, +* and PM_POSE types. Constructors in all the classes have been defined +* to convert to/from PM_CARTESIAN and any other translation type, and +* to convert to/from PM_QUATERNION and any other rotation type. This means +* that if no explicit C functions exist for another type, conversions +* to the corresponding native type will occur automatically. If more +* efficiency is desired for a particular type, C functions to handle the +* operations should be coded and the overloaded C++ functions or operators +* should be added. +* +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ + #ifndef POSEMATH_H #define POSEMATH_H -/* - posemath.h - - Declarations for pose math library data types and manipulation functions. - - Data types comprise various representations of translation and rotation - quantities, and a 'pose' for representing the location and orientation - of a frame in space relative to a base frame. Translation representations - include cartesian, spherical, and cylindrical coordinates. All of these - contain 3 elements. Rotation representations include rotation vectors, - quaternions, rotation matrices, Euler angles, and roll-pitch-yaw. These - contain at least 3 elements, and may contain more. Only 3 are necessary - for the 3 degrees of freedom for either translation or rotation, but some - data representations use more for computational efficiency or intuition - at the expense of storage space. - - Types are abbreviated in function naming with a few letters. Functions - exist for conversion between data types, checking for consistency, - normalization into consistency, extracting features such as size, and - arithmetic operations. - - Names of data representations are in all capitals, prefixed with 'PM_'. - Names of functions are in mixed case, prefixed with 'pm', with case changes - used to indicate new quantities instead of underscores. Function syntax - looks like - - int pmQuatRotConvert(PM_QUATERNION, PM_ROTATION_VECTOR *); - - The return value is an error code, 0 for success, or a non-zero error - code for failure, for example: - - #define PM_ERR -1 - #define PM_IMPL_ERR -2 - - The global variable 'pmErrno' is set to this return value. - - C++ classes are used for data types so that operator overloading can - be used to reduce the programming labor. Using the overloaded operator - version of functions loses the integer error code. The global - variable 'pmErrno' can be queried after these operations. This is not - thread-safe or reentrant. - - C++ names corresponding to the C structures use case mixing instead - of all caps. Thus, a quaternion in C++ is a PmQuaternion. - - The MATH_DEBUG symbol can be defined to include error reporting via - printed errors. - - Native efficient C functions exist for the PM_CARTESIAN, PM_QUATERNION, - and PM_POSE types. Constructors in all the classes have been defined - to convert to/from PM_CARTESIAN and any other translation type, and - to convert to/from PM_QUATERNION and any other rotation type. This means - that if no explicit C functions exist for another type, conversions - to the corresponding native type will occur automatically. If more - efficiency is desired for a particular type, C functions to handle the - operations should be coded and the overloaded C++ functions or operators - should be added. - - Modification History: - - 21-Jan-2004 P.C. Moved across from the original EMC source tree. -*/ - #ifdef __cplusplus #define USE_CONST diff --git a/src/libnml/posemath/sincos.c b/src/libnml/posemath/sincos.c index 364240119..f927a6696 100644 --- a/src/libnml/posemath/sincos.c +++ b/src/libnml/posemath/sincos.c @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: sincos.c +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #if HAVE_CONFIG_H #include "rcs_config.h" #endif diff --git a/src/libnml/posemath/sincos.h b/src/libnml/posemath/sincos.h index dc0dd72a1..9eadb488e 100644 --- a/src/libnml/posemath/sincos.h +++ b/src/libnml/posemath/sincos.h @@ -1,27 +1,28 @@ +/******************************************************************** +* Description: sincos.h +* support for native sincos functions +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef SINCOS_H #define SINCOS_H /* - sincos.h - - support for native sincos functions -*/ - -/* for each platform that has built-in support for the sincos function, define SINCOS_SUPPORT here */ -#ifdef sunos4 -#define SINCOS_SUPPORT -#endif - -#ifdef VXWORKS -#ifndef POWERPC -#define SINCOS_SUPPORT -#endif -#endif - #if defined (__GLIBC__) && defined(__USE_GNU) && defined(__FAST_MATH__) #define SINCOS_SUPPORT #define sincos __sincos diff --git a/src/libnml/rcs/rcs.hh b/src/libnml/rcs/rcs.hh index f6ad9e851..01bd2d9e8 100644 --- a/src/libnml/rcs/rcs.hh +++ b/src/libnml/rcs/rcs.hh @@ -1,7 +1,24 @@ +/******************************************************************** +* Description: rcs.hh +* This header should be included in each source that uses NML, CMS, +* or any other libnml function. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef RCS_HH #define RCS_HH -/* Include Files */ #ifdef __cplusplus /* Portable Print functions. */ diff --git a/src/libnml/rcs/rcs_exit.cc b/src/libnml/rcs/rcs_exit.cc index 181845393..0d0e1251e 100644 --- a/src/libnml/rcs/rcs_exit.cc +++ b/src/libnml/rcs/rcs_exit.cc @@ -1,9 +1,22 @@ -/********************************************************************** -* File: rcs_exit.cc -* This module provides a portable way to make sure multiple -* functions are called before exiting. -* These functions should be written to take an int and return void. -***********************************************************************/ +/******************************************************************** +* Description: rcs_exit.cc +* This module provides a portable way to make sure multiple +* functions are called before exiting. +* These functions should be written to take an int and return void. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ /* Forward Function Prototypes */ #include "rcs_exit.hh" diff --git a/src/libnml/rcs/rcs_exit.hh b/src/libnml/rcs/rcs_exit.hh index 95becc177..b7316b039 100644 --- a/src/libnml/rcs/rcs_exit.hh +++ b/src/libnml/rcs/rcs_exit.hh @@ -1,3 +1,22 @@ +/******************************************************************** +* Description: rcs_exit.hh +* This module provides a portable way to make sure multiple +* functions are called before exiting. +* These functions should be written to take an int and return void. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef RCS_EXIT_HH #define RCS_EXIT_HH diff --git a/src/libnml/rcs/rcs_print.cc b/src/libnml/rcs/rcs_print.cc index e82f5770e..501561e60 100644 --- a/src/libnml/rcs/rcs_print.cc +++ b/src/libnml/rcs/rcs_print.cc @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: rcs_print.cc +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifdef __cplusplus extern "C" { diff --git a/src/libnml/rcs/rcs_print.hh b/src/libnml/rcs/rcs_print.hh index 3b5e2608e..f6e0bf92f 100644 --- a/src/libnml/rcs/rcs_print.hh +++ b/src/libnml/rcs/rcs_print.hh @@ -1,3 +1,19 @@ +/******************************************************************** +* Description: rcs_print.hh +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef RCS_PRNT_HH #define RCS_PRNT_HH diff --git a/src/libnml/rcs/rcsversion.h b/src/libnml/rcs/rcsversion.h index 8b698ed67..e34d1f9fc 100644 --- a/src/libnml/rcs/rcsversion.h +++ b/src/libnml/rcs/rcsversion.h @@ -1,3 +1,20 @@ +/******************************************************************** +* Description: rcsversion.h +* Library version number. +* +* Derived from a work by Fred Proctor & Will Shackleford +* +* Author: +* License: GPL Version 2 +* System: Linux +* +* Copyright (c) 2004 All rights reserved. +* +* Last change: +* $Revision$ +* $Author$ +* $Date$ +********************************************************************/ #ifndef LIBVERSION_H #define LIBVERSION_H |