From f3c858afc8d8609124ba1bcf9e726cb5d7db685d Mon Sep 17 00:00:00 2001 From: "scc%mozilla.org" Date: Fri, 23 Feb 2001 02:43:42 +0000 Subject: [PATCH] bug #69907: rs=brendan. Fix file-level comments in (to be) obsolete string files so they are clearer in LXR directory views. git-svn-id: svn://10.0.0.236/trunk@87763 18797224-902f-48f8-a5cc-f745e15eee43 --- mozilla/string/obsolete/README.html | 5 ++++- mozilla/string/obsolete/bufferRoutines.h | 10 +++++++--- mozilla/string/obsolete/nsStr.cpp | 12 ++++++------ mozilla/string/obsolete/nsStr.h | 10 +++++++--- mozilla/string/obsolete/nsString.h | 10 +++++++--- mozilla/string/obsolete/nsString2.h | 10 +++++++--- mozilla/string/obsolete/nsXPIDLString.h | 13 ++++++++++--- mozilla/xpcom/string/obsolete/README.html | 5 ++++- mozilla/xpcom/string/obsolete/bufferRoutines.h | 10 +++++++--- mozilla/xpcom/string/obsolete/nsStr.cpp | 12 ++++++------ mozilla/xpcom/string/obsolete/nsStr.h | 10 +++++++--- mozilla/xpcom/string/obsolete/nsString.h | 10 +++++++--- mozilla/xpcom/string/obsolete/nsString2.h | 10 +++++++--- mozilla/xpcom/string/obsolete/nsXPIDLString.h | 13 ++++++++++--- 14 files changed, 96 insertions(+), 44 deletions(-) diff --git a/mozilla/string/obsolete/README.html b/mozilla/string/obsolete/README.html index a0f4a17c391..28dd61ea230 100644 --- a/mozilla/string/obsolete/README.html +++ b/mozilla/string/obsolete/README.html @@ -23,7 +23,10 @@

original string implementations soon to be replaced

- + These are the original string implementations by rickg and others. + Most of the code here will be made obsolete by the new shared-buffer string (see bug #53065). + If you're interested in learning how strings work, you probably want to start with + nsAReadableString.

diff --git a/mozilla/string/obsolete/bufferRoutines.h b/mozilla/string/obsolete/bufferRoutines.h index 31cc767171f..541d192358d 100644 --- a/mozilla/string/obsolete/bufferRoutines.h +++ b/mozilla/string/obsolete/bufferRoutines.h @@ -21,6 +21,13 @@ * Pierre Phaneuf */ +/* bufferRoutines.h --- rickg's original string manipulation underpinnings; + this code will be made obsolete by the new shared-buffer string (see bug #53065) + */ + +#ifndef _BUFFERROUTINES_H +#define _BUFFERROUTINES_H + /****************************************************************************************** MODULE NOTES: @@ -31,9 +38,6 @@ *******************************************************************************************/ -#ifndef _BUFFERROUTINES_H -#define _BUFFERROUTINES_H - #include "nsCRT.h" #ifndef XPCOM_STANDALONE diff --git a/mozilla/string/obsolete/nsStr.cpp b/mozilla/string/obsolete/nsStr.cpp index 888c63ca37b..87bf47bcdfb 100644 --- a/mozilla/string/obsolete/nsStr.cpp +++ b/mozilla/string/obsolete/nsStr.cpp @@ -24,6 +24,12 @@ * Scott Collins */ +#include "nsStr.h" +#include "bufferRoutines.h" +#include //only used for printf +#include "nsCRT.h" +#include "nsDeque.h" + /****************************************************************************************** MODULE NOTES: @@ -36,12 +42,6 @@ *******************************************************************************************/ -#include "nsStr.h" -#include "bufferRoutines.h" -#include //only used for printf -#include "nsCRT.h" -#include "nsDeque.h" - //static const char* kCallFindChar = "For better performance, call FindChar() for targets whose length==1."; //static const char* kCallRFindChar = "For better performance, call RFindChar() for targets whose length==1."; diff --git a/mozilla/string/obsolete/nsStr.h b/mozilla/string/obsolete/nsStr.h index c5e50045f19..4348d7ea9de 100644 --- a/mozilla/string/obsolete/nsStr.h +++ b/mozilla/string/obsolete/nsStr.h @@ -22,6 +22,13 @@ * Scott Collins */ +/* nsStr.h --- the underlying buffer for rickg's original string implementations; + these classes will be replaced by the new shared-buffer string (see bug #53065) + */ + +#ifndef _nsStr +#define _nsStr + /*********************************************************************** MODULE NOTES: @@ -181,9 +188,6 @@ **********************************************************************************/ -#ifndef _nsStr -#define _nsStr - #include "nscore.h" #include "nsMemory.h" #include diff --git a/mozilla/string/obsolete/nsString.h b/mozilla/string/obsolete/nsString.h index 5b1580f900f..bf6d0fe2268 100644 --- a/mozilla/string/obsolete/nsString.h +++ b/mozilla/string/obsolete/nsString.h @@ -22,6 +22,13 @@ * Scott Collins */ +/* nsString.h --- rickg's original strings of 1-byte chars, |nsCString| and |nsCAutoString|; + these classes will be replaced by the new shared-buffer string (see bug #53065) + */ + + +#ifndef _nsCString_ +#define _nsCString_ /*********************************************************************** MODULE NOTES: @@ -36,9 +43,6 @@ 4. Subsumable strings ***********************************************************************/ -#ifndef _nsCString_ -#define _nsCString_ - #include "nsString2.h" #include "prtypes.h" #include "nscore.h" diff --git a/mozilla/string/obsolete/nsString2.h b/mozilla/string/obsolete/nsString2.h index b7e954fe179..bb9740a0b42 100644 --- a/mozilla/string/obsolete/nsString2.h +++ b/mozilla/string/obsolete/nsString2.h @@ -22,8 +22,15 @@ * Scott Collins */ +/* nsString2.h --- rickg's original strings of 2-byte chars, |nsString| and |nsAutoString|; + these classes will be replaced by the new shared-buffer string (see bug #53065) + */ + +#ifndef _nsString_ +#define _nsString_ + /*********************************************************************** MODULE NOTES: @@ -37,9 +44,6 @@ 4. Subsumable strings ***********************************************************************/ -#ifndef _nsString_ -#define _nsString_ - #include "prtypes.h" #include "nscore.h" #include diff --git a/mozilla/string/obsolete/nsXPIDLString.h b/mozilla/string/obsolete/nsXPIDLString.h index 9f99d1a4a96..c1a30745cb9 100644 --- a/mozilla/string/obsolete/nsXPIDLString.h +++ b/mozilla/string/obsolete/nsXPIDLString.h @@ -20,6 +20,16 @@ * Contributor(s): */ +/* nsXPIDLString.h --- an `|auto_ptr|' for character buffers, this functionality will be replaced + by the new shared-buffer string (see bug #53065) + */ + + + + +#ifndef nsXPIDLString_h__ +#define nsXPIDLString_h__ + /* A set of string wrapper classes that ease transition to use of XPIDL @@ -77,9 +87,6 @@ */ -#ifndef nsXPIDLString_h__ -#define nsXPIDLString_h__ - #include "nscore.h" #include "nsCom.h" #include "prtypes.h" diff --git a/mozilla/xpcom/string/obsolete/README.html b/mozilla/xpcom/string/obsolete/README.html index a0f4a17c391..28dd61ea230 100644 --- a/mozilla/xpcom/string/obsolete/README.html +++ b/mozilla/xpcom/string/obsolete/README.html @@ -23,7 +23,10 @@

original string implementations soon to be replaced

- + These are the original string implementations by rickg and others. + Most of the code here will be made obsolete by the new shared-buffer string (see bug #53065). + If you're interested in learning how strings work, you probably want to start with + nsAReadableString.

diff --git a/mozilla/xpcom/string/obsolete/bufferRoutines.h b/mozilla/xpcom/string/obsolete/bufferRoutines.h index 31cc767171f..541d192358d 100644 --- a/mozilla/xpcom/string/obsolete/bufferRoutines.h +++ b/mozilla/xpcom/string/obsolete/bufferRoutines.h @@ -21,6 +21,13 @@ * Pierre Phaneuf */ +/* bufferRoutines.h --- rickg's original string manipulation underpinnings; + this code will be made obsolete by the new shared-buffer string (see bug #53065) + */ + +#ifndef _BUFFERROUTINES_H +#define _BUFFERROUTINES_H + /****************************************************************************************** MODULE NOTES: @@ -31,9 +38,6 @@ *******************************************************************************************/ -#ifndef _BUFFERROUTINES_H -#define _BUFFERROUTINES_H - #include "nsCRT.h" #ifndef XPCOM_STANDALONE diff --git a/mozilla/xpcom/string/obsolete/nsStr.cpp b/mozilla/xpcom/string/obsolete/nsStr.cpp index 888c63ca37b..87bf47bcdfb 100644 --- a/mozilla/xpcom/string/obsolete/nsStr.cpp +++ b/mozilla/xpcom/string/obsolete/nsStr.cpp @@ -24,6 +24,12 @@ * Scott Collins */ +#include "nsStr.h" +#include "bufferRoutines.h" +#include //only used for printf +#include "nsCRT.h" +#include "nsDeque.h" + /****************************************************************************************** MODULE NOTES: @@ -36,12 +42,6 @@ *******************************************************************************************/ -#include "nsStr.h" -#include "bufferRoutines.h" -#include //only used for printf -#include "nsCRT.h" -#include "nsDeque.h" - //static const char* kCallFindChar = "For better performance, call FindChar() for targets whose length==1."; //static const char* kCallRFindChar = "For better performance, call RFindChar() for targets whose length==1."; diff --git a/mozilla/xpcom/string/obsolete/nsStr.h b/mozilla/xpcom/string/obsolete/nsStr.h index c5e50045f19..4348d7ea9de 100644 --- a/mozilla/xpcom/string/obsolete/nsStr.h +++ b/mozilla/xpcom/string/obsolete/nsStr.h @@ -22,6 +22,13 @@ * Scott Collins */ +/* nsStr.h --- the underlying buffer for rickg's original string implementations; + these classes will be replaced by the new shared-buffer string (see bug #53065) + */ + +#ifndef _nsStr +#define _nsStr + /*********************************************************************** MODULE NOTES: @@ -181,9 +188,6 @@ **********************************************************************************/ -#ifndef _nsStr -#define _nsStr - #include "nscore.h" #include "nsMemory.h" #include diff --git a/mozilla/xpcom/string/obsolete/nsString.h b/mozilla/xpcom/string/obsolete/nsString.h index 5b1580f900f..bf6d0fe2268 100644 --- a/mozilla/xpcom/string/obsolete/nsString.h +++ b/mozilla/xpcom/string/obsolete/nsString.h @@ -22,6 +22,13 @@ * Scott Collins */ +/* nsString.h --- rickg's original strings of 1-byte chars, |nsCString| and |nsCAutoString|; + these classes will be replaced by the new shared-buffer string (see bug #53065) + */ + + +#ifndef _nsCString_ +#define _nsCString_ /*********************************************************************** MODULE NOTES: @@ -36,9 +43,6 @@ 4. Subsumable strings ***********************************************************************/ -#ifndef _nsCString_ -#define _nsCString_ - #include "nsString2.h" #include "prtypes.h" #include "nscore.h" diff --git a/mozilla/xpcom/string/obsolete/nsString2.h b/mozilla/xpcom/string/obsolete/nsString2.h index b7e954fe179..bb9740a0b42 100644 --- a/mozilla/xpcom/string/obsolete/nsString2.h +++ b/mozilla/xpcom/string/obsolete/nsString2.h @@ -22,8 +22,15 @@ * Scott Collins */ +/* nsString2.h --- rickg's original strings of 2-byte chars, |nsString| and |nsAutoString|; + these classes will be replaced by the new shared-buffer string (see bug #53065) + */ + +#ifndef _nsString_ +#define _nsString_ + /*********************************************************************** MODULE NOTES: @@ -37,9 +44,6 @@ 4. Subsumable strings ***********************************************************************/ -#ifndef _nsString_ -#define _nsString_ - #include "prtypes.h" #include "nscore.h" #include diff --git a/mozilla/xpcom/string/obsolete/nsXPIDLString.h b/mozilla/xpcom/string/obsolete/nsXPIDLString.h index 9f99d1a4a96..c1a30745cb9 100644 --- a/mozilla/xpcom/string/obsolete/nsXPIDLString.h +++ b/mozilla/xpcom/string/obsolete/nsXPIDLString.h @@ -20,6 +20,16 @@ * Contributor(s): */ +/* nsXPIDLString.h --- an `|auto_ptr|' for character buffers, this functionality will be replaced + by the new shared-buffer string (see bug #53065) + */ + + + + +#ifndef nsXPIDLString_h__ +#define nsXPIDLString_h__ + /* A set of string wrapper classes that ease transition to use of XPIDL @@ -77,9 +87,6 @@ */ -#ifndef nsXPIDLString_h__ -#define nsXPIDLString_h__ - #include "nscore.h" #include "nsCom.h" #include "prtypes.h"