Systematizing the formatting

Also simplified the AIX loader so that it's failure-mode code wasn't scattered
all over quite so much.

1 files changed, 69 insertions, 59 deletions

diff --git a/unix/tclLoadDl.c b/unix/tclLoadDl.c
index 1a51dd8..a78b989 100644
--- a/unix/tclLoadDl.c
+++ b/unix/tclLoadDl.c
@@ -1,16 +1,15 @@
-/* 
+/*
  * tclLoadDl.c --
  *
- *	This procedure provides a version of the TclLoadFile that
- *	works with the "dlopen" and "dlsym" library procedures for
- *	dynamic loading.
+ *	This procedure provides a version of the TclLoadFile that works with
+ *	the "dlopen" and "dlsym" library procedures for dynamic loading.
  *
  * Copyright (c) 1995-1997 Sun Microsystems, Inc.
  *
- * See the file "license.terms" for information on usage and redistribution
- * of this file, and for a DISCLAIMER OF ALL WARRANTIES.
+ * See the file "license.terms" for information on usage and redistribution of
+ * this file, and for a DISCLAIMER OF ALL WARRANTIES.
  *
- * RCS: @(#) $Id: tclLoadDl.c,v 1.13 2002/10/10 12:25:53 vincentdarley Exp $
+ * RCS: @(#) $Id: tclLoadDl.c,v 1.14 2005/07/19 13:37:18 dkf Exp $
  */
 
 #include "tclInt.h"
@@ -21,10 +20,10 @@
 #endif
 
 /*
- * In some systems, like SunOS 4.1.3, the RTLD_NOW flag isn't defined
- * and this argument to dlopen must always be 1.  The RTLD_GLOBAL
- * flag is needed on some systems (e.g. SCO and UnixWare) but doesn't
- * exist on others;  if it doesn't exist, set it to 0 so it has no effect.
+ * In some systems, like SunOS 4.1.3, the RTLD_NOW flag isn't defined and this
+ * argument to dlopen must always be 1. The RTLD_GLOBAL flag is needed on some
+ * systems (e.g. SCO and UnixWare) but doesn't exist on others; if it doesn't
+ * exist, set it to 0 so it has no effect.
  */
 
 #ifndef RTLD_NOW
@@ -40,12 +39,12 @@
  *
  * TclpDlopen --
  *
- *	Dynamically loads a binary code file into memory and returns
- *	a handle to the new code.
+ *	Dynamically loads a binary code file into memory and returns a handle
+ *	to the new code.
  *
  * Results:
- *	A standard Tcl completion code.  If an error occurs, an error
- *	message is left in the interp's result. 
+ *	A standard Tcl completion code. If an error occurs, an error message
+ *	is left in the interp's result.
  *
  * Side effects:
  *	New code suddenly appears in memory.
@@ -59,40 +58,42 @@ TclpDlopen(interp, pathPtr, loadHandle, unloadProcPtr)
     Tcl_Obj *pathPtr;		/* Name of the file containing the desired
 				 * code (UTF-8). */
     Tcl_LoadHandle *loadHandle;	/* Filled with token for dynamically loaded
-				 * file which will be passed back to 
+				 * file which will be passed back to
 				 * (*unloadProcPtr)() to unload the file. */
-    Tcl_FSUnloadFileProc **unloadProcPtr;	
+    Tcl_FSUnloadFileProc **unloadProcPtr;
 				/* Filled with address of Tcl_FSUnloadFileProc
-				 * function which should be used for
-				 * this file. */
+				 * function which should be used for this
+				 * file. */
 {
     VOID *handle;
     CONST char *native;
 
-    /* 
-     * First try the full path the user gave us.  This is particularly
-     * important if the cwd is inside a vfs, and we are trying to load
-     * using a relative path.
+    /*
+     * First try the full path the user gave us. This is particularly
+     * important if the cwd is inside a vfs, and we are trying to load using a
+     * relative path.
      */
+
     native = Tcl_FSGetNativePath(pathPtr);
     handle = dlopen(native, RTLD_NOW | RTLD_GLOBAL);
     if (handle == NULL) {
-	/* 
-	 * Let the OS loader examine the binary search path for
-	 * whatever string the user gave us which hopefully refers
-	 * to a file on the binary path
+	/*
+	 * Let the OS loader examine the binary search path for whatever
+	 * string the user gave us which hopefully refers to a file on the
+	 * binary path.
 	 */
+
 	Tcl_DString ds;
 	char *fileName = Tcl_GetString(pathPtr);
+
 	native = Tcl_UtfToExternalDString(NULL, fileName, -1, &ds);
 	handle = dlopen(native, RTLD_NOW | RTLD_GLOBAL);
 	Tcl_DStringFree(&ds);
     }
-    
+
     if (handle == NULL) {
-	Tcl_AppendResult(interp, "couldn't load file \"", 
-			 Tcl_GetString(pathPtr),
-			 "\": ", dlerror(), (char *) NULL);
+	Tcl_AppendResult(interp, "couldn't load file \"",
+		Tcl_GetString(pathPtr), "\": ", dlerror(), (char *) NULL);
 	return TCL_ERROR;
     }
 
@@ -106,35 +107,37 @@ TclpDlopen(interp, pathPtr, loadHandle, unloadProcPtr)
  *
  * TclpFindSymbol --
  *
- *	Looks up a symbol, by name, through a handle associated with
- *	a previously loaded piece of code (shared library).
+ *	Looks up a symbol, by name, through a handle associated with a
+ *	previously loaded piece of code (shared library).
  *
  * Results:
- *	Returns a pointer to the function associated with 'symbol' if
- *	it is found.  Otherwise returns NULL and may leave an error
- *	message in the interp's result.
+ *	Returns a pointer to the function associated with 'symbol' if it is
+ *	found. Otherwise returns NULL and may leave an error message in the
+ *	interp's result.
  *
  *----------------------------------------------------------------------
  */
+
 Tcl_PackageInitProc*
-TclpFindSymbol(interp, loadHandle, symbol) 
-    Tcl_Interp *interp;
-    Tcl_LoadHandle loadHandle;
-    CONST char *symbol;
+TclpFindSymbol(interp, loadHandle, symbol)
+    Tcl_Interp *interp;		/* Place to put error messages. */
+    Tcl_LoadHandle loadHandle;	/* Value from TcpDlopen(). */
+    CONST char *symbol;		/* Symbol to look up. */
 {
     CONST char *native;
     Tcl_DString newName, ds;
     VOID *handle = (VOID*)loadHandle;
     Tcl_PackageInitProc *proc;
-    /* 
+
+    /*
      * Some platforms still add an underscore to the beginning of symbol
-     * names.  If we can't find a name without an underscore, try again
-     * with the underscore.
+     * names. If we can't find a name without an underscore, try again with
+     * the underscore.
      */
 
     native = Tcl_UtfToExternalDString(NULL, symbol, -1, &ds);
     proc = (Tcl_PackageInitProc *) dlsym(handle,	/* INTL: Native. */
-	    native);	
+	    native);
     if (proc == NULL) {
 	Tcl_DStringInit(&newName);
 	Tcl_DStringAppend(&newName, "_", 1);
@@ -153,9 +156,9 @@ TclpFindSymbol(interp, loadHandle, symbol)
  *
  * TclpUnloadFile --
  *
- *	Unloads a dynamically loaded binary code file from memory.
- *	Code pointers in the formerly loaded file are no longer valid
- *	after calling this function.
+ *	Unloads a dynamically loaded binary code file from memory. Code
+ *	pointers in the formerly loaded file are no longer valid after calling
+ *	this function.
  *
  * Results:
  *	None.
@@ -168,10 +171,9 @@ TclpFindSymbol(interp, loadHandle, symbol)
 
 void
 TclpUnloadFile(loadHandle)
-    Tcl_LoadHandle loadHandle;	/* loadHandle returned by a previous call
-				 * to TclpDlopen().  The loadHandle is 
-				 * a token that represents the loaded 
-				 * file. */
+    Tcl_LoadHandle loadHandle;	/* loadHandle returned by a previous call to
+				 * TclpDlopen(). The loadHandle is a token
+				 * that represents the loaded file. */
 {
     VOID *handle;
 
@@ -184,14 +186,14 @@ TclpUnloadFile(loadHandle)
  *
  * TclGuessPackageName --
  *
- *	If the "load" command is invoked without providing a package
- *	name, this procedure is invoked to try to figure it out.
+ *	If the "load" command is invoked without providing a package name,
+ *	this procedure is invoked to try to figure it out.
  *
  * Results:
- *	Always returns 0 to indicate that we couldn't figure out a
- *	package name;  generic code will then try to guess the package
- *	from the file name.  A return value of 1 would have meant that
- *	we figured out the package name and put it in bufPtr.
+ *	Always returns 0 to indicate that we couldn't figure out a package
+ *	name; generic code will then try to guess the package from the file
+ *	name. A return value of 1 would have meant that we figured out the
+ *	package name and put it in bufPtr.
  *
  * Side effects:
  *	None.
@@ -203,8 +205,16 @@ int
 TclGuessPackageName(fileName, bufPtr)
     CONST char *fileName;	/* Name of file containing package (already
 				 * translated to local form if needed). */
-    Tcl_DString *bufPtr;	/* Initialized empty dstring.  Append
-				 * package name to this if possible. */
+    Tcl_DString *bufPtr;	/* Initialized empty dstring. Append package
+				 * name to this if possible. */
 {
     return 0;
 }
+
+/*
+ * Local Variables:
+ * mode: c
+ * c-basic-offset: 4
+ * fill-column: 78
+ * End:
+ */