Patch by Vasilis Kaoutsis - thanks!:

* Rewrote TextView.h
* Renamed all private methods to have the underscore prefix.
And also:
* Whitespace and line width cleanup.


git-svn-id: file:///srv/svn/repos/haiku/haiku/trunk@22688 a95241bf-73f2-0310-859d-f6bbb57e9c96

headers/os/interface/TextView.h

@@ -1,44 +1,15 @@
-/*******************************************************************************
+/*
-/
+ * Copyright (c) 2007, Haiku, Inc.
-/	File:			TextView.h
+ * Distributed under the terms of the MIT license.
-/
+ */
-/   Description:    BTextView displays and manages styled text.
-/
-/	Copyright 1993-98, Be Incorporated, All Rights Reserved
-/
-*******************************************************************************/
-
 #ifndef _TEXTVIEW_H
 #define _TEXTVIEW_H
 
+
 #include <BeBuild.h>
 #include <View.h>
 
 class BMessageRunner;
-
-/*----------------------------------------------------------------*/
-/*----- BTextView structures and definitions ---------------------*/
-
-struct text_run {
-	int32			offset;		/* byte offset of first character of run*/
-	BFont			font;		/* font of run*/
-	rgb_color		color;		/* color of run*/
-};
-
-struct text_run_array {
-	int32			count;		/* number of text runs*/
-	text_run		runs[1];	/* array of count number of runs*/
-};
-
-enum undo_state {
-	B_UNDO_UNAVAILABLE,
-	B_UNDO_TYPING,
-	B_UNDO_CUT,
-	B_UNDO_PASTE,
-	B_UNDO_CLEAR,
-	B_UNDO_DROP
-};
-
 class BBitmap;
 class BClipboard;
 class BFile;
@@ -54,23 +25,34 @@ class _BTextChangeResult_;
 
 extern "C" status_t	_init_interface_kit_();
 
-/*----------------------------------------------------------------*/
+
-/*----- BTextView class ------------------------------------------*/
+struct text_run {
+	int32		offset;
+	BFont		font;
+	rgb_color	color;
+};
+
+struct text_run_array {
+	int32		count;
+	text_run	runs[1];
+};
+
+enum undo_state {
+	B_UNDO_UNAVAILABLE,
+	B_UNDO_TYPING,
+	B_UNDO_CUT,
+	B_UNDO_PASTE,
+	B_UNDO_CLEAR,
+	B_UNDO_DROP
+};
 
 class BTextView : public BView {
 	public:
-						BTextView(BRect			frame,
+		BTextView(BRect frame, const char* name, BRect textRect,
-								  const char	*name,
+			uint32 resizeMask, uint32 flags = B_WILL_DRAW | B_PULSE_NEEDED);
-								  BRect			textRect,
+		BTextView(BRect	frame, const char* name, BRect textRect,
-								  uint32		resizeMask,
+			const BFont* initialFont, const rgb_color* initialColor,
-								  uint32		flags = B_WILL_DRAW | B_PULSE_NEEDED);
+			uint32 resizeMask, uint32 flags);
-						BTextView(BRect				frame, 
-								  const char		*name, 
-								  BRect				textRect,
-						 	 	  const BFont		*initialFont,
-								  const rgb_color	*initialColor, 
-								  uint32			resizeMask, 
-								  uint32			flags);
 		BTextView(BMessage* data);
 		virtual	~BTextView();
 
@@ -82,8 +64,7 @@ virtual	void			DetachedFromWindow();
 		virtual	void Draw(BRect inRect);
 		virtual	void MouseDown(BPoint where);
 		virtual void MouseUp(BPoint where);
-virtual	void			MouseMoved(BPoint			where, 
+		virtual	void MouseMoved(BPoint where, uint32 code,
-								   uint32			code, 
 			const BMessage* message);
 		virtual	void WindowActivated(bool state);
 		virtual	void KeyDown(const char* bytes, int32 numBytes);
@@ -91,43 +72,29 @@ virtual	void			Pulse();
 		virtual	void FrameResized(float width, float height);
 		virtual	void MakeFocus(bool focusState = true);
 		virtual	void MessageReceived(BMessage* message);
-virtual BHandler*		ResolveSpecifier(BMessage *message,
+
-										 int32 index,
+		virtual BHandler* ResolveSpecifier(BMessage* message, int32 index,
-										 BMessage *specifier,
+			BMessage* specifier, int32 form, const char* property);
-										 int32 form,
-										 const char *property);
 		virtual status_t GetSupportedSuites(BMessage* data);
 		virtual status_t Perform(perform_code d, void* arg);
 
-		void			SetText(const char *inText, 
+		void SetText(const char* inText, const text_run_array* inRuns = NULL);
+		void SetText(const char* inText, int32 inLength,
 			const text_run_array* inRuns = NULL);
-		void			SetText(const char *inText, 
+		void SetText(BFile* inFile, int32 startOffset, int32 inLength,
-								int32 inLength,
-								const text_run_array *inRuns = NULL);
-		void			SetText(BFile *inFile,
-								int32 startOffset,
-								int32 inLength,
 			const text_run_array* inRuns = NULL);
 
-		void			Insert(const char *inText, 
+		void Insert(const char* inText, const text_run_array* inRuns = NULL);
-							   const text_run_array *inRuns = NULL);
+		void Insert(const char* inText, int32 inLength, const text_run_array* inRuns = NULL);
-		void			Insert(const char *inText, 
+		void Insert(int32 startOffset, const char* inText, int32 inLength, const text_run_array* inRuns = NULL);
-							   int32 inLength,
-							   const text_run_array *inRuns = NULL);
-		void			Insert(int32 startOffset,
-							   const char *inText,
-							   int32 inLength,
-							   const text_run_array *inRuns = NULL);
 
 		void Delete();
 		void Delete(int32 startOffset, int32 endOffset);
 
 		const char*	Text() const;
 		int32 TextLength() const;
-		void			GetText(int32 offset, 
+		void GetText(int32 offset, int32 length, char* buffer) const;
-								int32 length,
+		uint8 ByteAt(int32 offset) const;
-								char *buffer) const;
-		uchar			ByteAt(int32 offset) const;
 
 		int32 CountLines() const;
 		int32 CurrentLine() const;
@@ -145,28 +112,20 @@ virtual	void			Select(int32 startOffset, int32 endOffset);
 		void SelectAll();
 		void GetSelection(int32* outStart, int32* outEnd) const;
 
-		void			SetFontAndColor(const BFont		*inFont, 
+		void SetFontAndColor(const BFont* inFont, uint32 inMode = B_FONT_ALL,
-										uint32			inMode = B_FONT_ALL,
 			const rgb_color* inColor = NULL);
-		void			SetFontAndColor(int32			startOffset, 
+		void SetFontAndColor(int32 startOffset, int32 endOffset,
-										int32			endOffset, 
+			const BFont* inFont, uint32 inMode = B_FONT_ALL,
-										const BFont		*inFont,
-										uint32			inMode = B_FONT_ALL,
 			const rgb_color* inColor = NULL);
 
-		void			GetFontAndColor(int32		inOffset, 
+		void GetFontAndColor(int32 inOffset, BFont* outFont,
-										BFont		*outFont,
 			rgb_color* outColor = NULL) const;
-		void			GetFontAndColor(BFont		*outFont,
+		void GetFontAndColor(BFont* outFont, uint32* sameProperties,
-										uint32		*outMode, 
+			rgb_color* outColor = NULL, bool* sameColor = NULL) const;
-										rgb_color	*outColor = NULL,
-										bool		*outEqColor = NULL) const;
 
-		void			SetRunArray(int32					startOffset, 
+		void SetRunArray(int32 startOffset, int32 endOffset,
-									int32					endOffset, 
 			const text_run_array* inRuns);
-		text_run_array*	RunArray(int32	startOffset, 
+		text_run_array*	RunArray(int32	startOffset, int32	endOffset,
-								 int32	endOffset,
 			int32* outSize = NULL) const;
 
 		int32 LineAt(int32 offset) const;
@@ -175,8 +134,7 @@ virtual	void			Select(int32 startOffset, int32 endOffset);
 		int32 OffsetAt(BPoint point) const;
 		int32 OffsetAt(int32 line) const;
 
-virtual	void			FindWord(int32	inOffset, 
+		virtual	void FindWord(int32	inOffset, int32* outFromOffset,
-								 int32	*outFromOffset, 
 			int32* outToOffset);
 
 		virtual	bool CanEndLine(int32 offset);
@@ -185,8 +143,7 @@ virtual	bool			CanEndLine(int32 offset);
 		float LineHeight(int32 lineNum = 0) const;
 		float TextHeight(int32 startLine, int32 endLine) const;
 
-		void			GetTextRegion(int32		startOffset, 
+		void GetTextRegion(int32 startOffset, int32 endOffset,
-									  int32		endOffset,
 			BRegion* outRegion) const;
 
 		virtual	void ScrollToOffset(int32 inOffset);
@@ -221,25 +178,26 @@ virtual	void			ScrollToOffset(int32 inOffset);
 		void SetDoesUndo(bool undo);
 		bool DoesUndo() const;		
 		void HideTyping(bool enabled);
-		bool			IsTypingHidden(void) const;	
+		bool IsTypingHidden() const;	
 
 		virtual void ResizeToPreferred();
-virtual void			GetPreferredSize(float *width, float *height);
+		virtual void GetPreferredSize(float* _width, float* _height);
 		virtual void AllAttached();
 		virtual void AllDetached();
 
-
+		static text_run_array* AllocRunArray(int32 entryCount,
-static	text_run_array*		AllocRunArray(int32 entryCount, int32 *outSize = NULL);
+			int32* outSize = NULL);
-static	text_run_array* 	CopyRunArray(const text_run_array *orig, int32 countDelta = 0);
+		static text_run_array* CopyRunArray(const text_run_array* orig,
+			int32 countDelta = 0);
 		static void FreeRunArray(text_run_array* array);
-static	void *			FlattenRunArray(const text_run_array *inArray, int32 *outSize = NULL);
+		static void* FlattenRunArray(const text_run_array* inArray,
-static	text_run_array*		UnflattenRunArray(const void *data, int32 *outSize = NULL);
+			int32* outSize = NULL);
+		static text_run_array* UnflattenRunArray(const void* data,
+			int32* outSize = NULL);
 
 	protected:
-virtual	void			InsertText(const char				*inText, 
+		virtual	void InsertText(const char* inText, int32 inLength,
-								   int32					inLength, 
+			int32 inOffset, const text_run_array* inRuns);
-								   int32					inOffset,
-								   const text_run_array		*inRuns);
 		virtual	void DeleteText(int32 fromOffset, int32 toOffset);
 
 	public:
@@ -248,12 +206,10 @@ virtual	void			Undo(BClipboard *clipboard);
 
 	protected:
 		void _ScrollToOffset(int32 nOffset, bool useHorz, bool useVert);
-virtual	void			GetDragParameters(BMessage	*drag, 
-										  BBitmap	**bitmap,
-										  BPoint	*point,
-										  BHandler	**handler);
 
-/*----- Private or reserved -----------------------------------------*/
+		virtual	void GetDragParameters(BMessage* drag, BBitmap** _bitmap,
+			BPoint* point, BHandler** _handler);
+
 	private:
 		friend status_t	_init_interface_kit_();
 		friend class _BTextTrackState_;
@@ -269,110 +225,88 @@ virtual void			_ReservedTextView10();
 		virtual void _ReservedTextView11();
 		virtual void _ReservedTextView12();
 
-		void			InitObject(BRect			textRect, 
+		void _InitObject(BRect textRect, const BFont* initialFont,
-								   const BFont		*initialFont,
 			const rgb_color* initialColor);
 
-		void			HandleBackspace();
+		void _HandleBackspace();
-		void			HandleArrowKey(uint32 inArrowKey);
+		void _HandleArrowKey(uint32 inArrowKey);
-		void			HandleDelete();
+		void _HandleDelete();
-		void			HandlePageKey(uint32 inPageKey);
+		void _HandlePageKey(uint32 inPageKey);
-		void			HandleAlphaKey(const char *bytes, int32 numBytes);
+		void _HandleAlphaKey(const char* bytes, int32 numBytes);
 
-		void			Refresh(int32	fromOffset, 
+		void _Refresh(int32 fromOffset, int32 toOffset, bool erase, bool scroll);
-								int32	toOffset, 
+		void _RecalculateLineBreaks(int32* startLine, int32* endLine);
-								bool	erase, 
+		int32 _FindLineBreak(int32 fromOffset, float* outAscent,
-								bool	scroll);
+			float* outDescent, float* ioWidth);
-		void			RecalculateLineBreaks(int32 *startLine, int32 *endLine);
-		int32			FindLineBreak(int32	fromOffset, 
-									  float	*outAscent, 
-								  	  float	*outDescent, 
-									  float	*ioWidth);
 
-		float			StyledWidth(int32	fromOffset, 
+		float _StyledWidth(int32 fromOffset, int32 length,
-									int32	length,
+			float* outAscent = NULL, float* outDescent = NULL) const;
-									float	*outAscent = NULL, 
-									float	*outDescent = NULL) const;
-		float			StyledWidthUTF8Safe(int32 fromOffset,
-											int32 numChars,
-											float	*outAscent = NULL, 
-											float	*outDescent = NULL) const;
 
-		float			ActualTabWidth(float location) const;
+		float _StyledWidthUTF8Safe(int32 fromOffset, int32 numChars,
+			float* outAscent = NULL, float* outDescent = NULL) const;
 
-		void			DoInsertText(const char				*inText, 
+		float _ActualTabWidth(float location) const;
-									 int32					inLength, 
+
-									 int32					inOffset,
+		void _DoInsertText(const char* inText, int32 inLength, int32 inOffset,
-									 const text_run_array	*inRuns,
+			const text_run_array* inRuns, _BTextChangeResult_* outResult);
-									 _BTextChangeResult_	*outResult);
+
-		void			DoDeleteText(int32					fromOffset,
+		void _DoDeleteText(int32 fromOffset, int32 toOffset,
-									 int32					toOffset,
 			_BTextChangeResult_* outResult);
 
 		void _DrawLine(BView* view, const int32 &startLine,
-								const int32 &startOffset,
+			const int32& startOffset, const bool& erase, BRect& eraseRect,
-								const bool &erase,
-								BRect &eraseRect,
 			BRegion& inputRegion);
-		void			DrawLines(int32	startLine, 
+
-								  int32	endLine, 
+		void _DrawLines(int32 startLine, int32 endLine, int32 startOffset = -1,
-							  	  int32	startOffset = -1, 
 			bool erase = false);
-		void			DrawCaret(int32 offset);
+		void _DrawCaret(int32 offset);
 		void _ShowCaret();
 		void _HideCaret();		
-		void			InvertCaret();
+		void _InvertCaret();
-		void			DragCaret(int32 offset);
+		void _DragCaret(int32 offset);
 
-		void			StopMouseTracking();
+		void _StopMouseTracking();
-		bool			PerformMouseUp(BPoint where);
+		bool _PerformMouseUp(BPoint where);
-		bool			PerformMouseMoved(BPoint			where, 
+		bool _PerformMouseMoved(BPoint where, uint32 code);
-										  uint32			code);
 
-		void			TrackMouse(BPoint where, const BMessage *message,
+		void _TrackMouse(BPoint where, const BMessage* message,
 			bool force = false);
 
-		void			TrackDrag(BPoint where);
+		void _TrackDrag(BPoint where);
-		void			InitiateDrag();
+		void _InitiateDrag();
-		bool			MessageDropped(BMessage	*inMessage, 
+		bool _MessageDropped(BMessage* inMessage, BPoint where, BPoint offset);
-									   BPoint	where,
-									   BPoint	offset);
 
-		void			PerformAutoScrolling();									
+		void _PerformAutoScrolling();									
-		void			UpdateScrollbars();
+		void _UpdateScrollbars();
-		void			AutoResize(bool doRedraw = true);
+		void _AutoResize(bool doRedraw = true);
 
-		void			NewOffscreen(float padding = 0.0F);
+		void _NewOffscreen(float padding = 0.0F);
-		void			DeleteOffscreen();
+		void _DeleteOffscreen();
 
-		void			Activate();
+		void _Activate();
-		void			Deactivate();
+		void _Deactivate();
 
-		void			NormalizeFont(BFont *font);
+		void _NormalizeFont(BFont* font);
 
 		void _SetRunArray(int32 startOffset, int32 endOffset,
 			const text_run_array* inRuns);
 
-		uint32			CharClassification(int32 offset) const;
+		uint32 _CharClassification(int32 offset) const;
-		int32			NextInitialByte(int32 offset) const;
+		int32 _NextInitialByte(int32 offset) const;
-		int32			PreviousInitialByte(int32 offset) const;
+		int32 _PreviousInitialByte(int32 offset) const;
 
-		bool			GetProperty(BMessage	*specifier,
+		bool _GetProperty(BMessage* specifier, int32 form, const char* property,
-									int32		form, 
-									const char	*property,
-									BMessage	*reply);
-		bool			SetProperty(BMessage	*specifier,
-									int32		form, 
-									const char	*property,
-									BMessage	*reply);
-		bool			CountProperties(BMessage	*specifier,
-										int32		form,
-										const char	*property,
 			BMessage* reply);
 
-		void			HandleInputMethodChanged(BMessage *message);
+		bool _SetProperty(BMessage* specifier, int32 form, const char* property,
-		void			HandleInputMethodLocationRequest();
+			BMessage* reply);
-		void			CancelInputMethod();
+
+		bool _CountProperties(BMessage* specifier, int32 form,
+			const char* property, BMessage* reply);
+
+		void _HandleInputMethodChanged(BMessage* message);
+		void _HandleInputMethodLocationRequest();
+		void _CancelInputMethod();
 
 		static void LockWidthBuffer();
 		static void UnlockWidthBuffer();	
@@ -418,7 +352,4 @@ static	sem_id					sWidthSem;
 		static int32			sWidthAtom;
 };
 
-/*-------------------------------------------------------------*/
+#endif	// _TEXTVIEW_H
-/*-------------------------------------------------------------*/
-
-#endif /* _TEXT_VIEW_H */