Revert "We need to use UTF8 string encoding instead of ASCII because we're receiving XML. Socket code should be perfect now."

This reverts commit 3e0ed926b2280e94306e76d829780062552d4c34.

Mark one of the fixes as bug 157

Add a toolbar icon for the HUD window, which required making DebuggerController the action handler.

* Icons/HUDIcon.png: New icon
* CONTRIBUTORS: Add credits for icon
* MacGDBp.xcodeproj/project.pbxproj: Project updates for icon
* Source/AppDelegate.h+m:
(showInspectorWindow:): Moved to...
* Source/DebuggerController.h+m:
(showInspectorWindow:): new from ^
* English.lproj/Debugger.xib: Add toolbar item
* English.lproj/MainMenu.xib: Change Window-->Inspector's target

We need to use UTF8 string encoding instead of ASCII because we're receiving XML. Socket code should be perfect now.

* Source/SocketWrapper.m:
(receive)

Put the debugger behavior settings above the Xdebug ones

* English.lproj/Preferences.xib

Rewrote -[SocketWrapper receive] so that we do not get any more partial/broken packets, hopefully.

* Source/SocketWrapper.m:
(receive)

More fixes for paths with spaces. We can't use single quotes to pass path names, so create a new method to escape them.

* Source/GDBpConnection.m:
(escapedURIPath): New private method that takes a path and returns a safe file:// URI
(addBreakpoint:): Use -[escapedURIPath:]
(createStackFrame:): Don't pass the escaped path to the frame, keep it internally

Don't try to manage the stack using internal state anymore, simply grab it every time from the engine

* Soure/DebuggerController.m:
(stepIn:): The GDBpConnection methods no longer return anything, get entire stack now
(stepOut:): ditto
(stepOver:): ditto
* Soure/GDBpConnection.h+m:
(run): Return void
(stepIn): ditto
(stepOut): ditto
(stepOver): ditto

Add a preference to disable automatic step-in upon connection

* English.lproj/Preferences.xib: Add checkbox to the general prefs
* Source/AppDelegate.m: Add NSUserDefaults default value
* Source/DebuggerController.m:
(startDebugger): Check pref before stepping

Fix a type mismatch compile error

* Source/GDBpConnection.h: Change NSArray to StackFrame for -[run]

Merge branch 'bug-157'

Conflicts:
Source/DebuggerController.m
Source/GDBpConnection.m

Merge branch 'cosmetics'

Conflicts:
CHANGES
Source/GDBpConnection.m

Factored out the stack reloading code

* Source/DebuggerController.m:
(reloadStack): New private method to fetch and insert new stack
(run): Use reloadStack
* Source/GDBpConnection.m+h:
(getCurrentStack): New method to get the stack and create all the stack frames
(run): Return only the current stack frame instead of a whole stack

Add NSLog()s around the send/receive stuff so we can track activity with Xdebug

* MacGDBp.xcodeproj: In debug mode, define BLU_DEBUG as a C flag
* Source/GDBpConnection.m:
(createCommand:)
(processData:)

When getting the source, we need to escape the '%20' space character so the source displays properly

* Source/GDBpConnection.m:
(createStackFrame)

Breakpoints with a space in the filename would not be set.

* Source/GDBpConnection.m:
(addBreakpoint:): Quote the breakpoint path before sending the GDBp command

Make the asterisk attached to the type, rather than the variable.

Fix the run command by having it obliterate the current stack and set a new one

* Source/GDBpConnection.h+m:
(run): Now returns an NSArray of the new stack frames
(createStackFrame): Sets the StackFrame's index to be the depth
* Source/DebuggerController.m:
(run:): Set the new stack and refresh the source viewer

Change -[createStackFrame] to take a depth and create private -[createCurrentStackFrame] to call it with depth 0

* Source/GDBpConnection.m:
(createStackFrame:): Take a new depth argument
(createCurrentStackFrame): New method to call above with 0

Set the version to be 1.3

* Info.plist

Set the SourceView.file to nil and tell the stack NSArrayController to rearrange

* Source/DebuggerController.m:
(resetDisplays)

Make -[GDBpConnection(Private) createCommand:] take a variable number of arguments to parse

* Source/GDBpConnection.m:
(createCommand:)

Before setting selectedVariable, we need to make sure there is a selection!

* Source/DebuggerController.m:
(stepIn:)
(stepOut:)
(stepOver:)

Retain the selection in the variable list when stepping through code

* Source/DebuggerController.h: Add the selectedVariable ivar
* Source/DebuggerController.m:
(stepIn:): Save selected variable
(stepOut:): ditto
(stepOver:): ditto
(expandVariables): When looping over variables to expand, also reset the selection

NSLog() when Xdebug returns us an error

* Source/GDBpConnection.m:
(processData:)

Not all breakpoint markers would be displayed in the active code debugger

* Source/DebuggerController.m:
(updateSourceViewer): Get all the breakpoints for the file and set the markers

Update the changelog

Have the inspector remember its visibility

* Source/AppDelegate.m:
(load): Set the default value
* Source/DebuggerController.m:
(init): Show/hide the inspector based on prefs
* English.lproj/Debugger.xib: Bind the inspector's visibility

When toggling the breakpoints window, we also need to check to make sure if it's visible but not key

* Source/AppDelegate.m:
(showBreakpointWindow:): If the window is visible but not key, order it front

Add an item to the Window menu to allow the inspector to be shown/hidden

* Source/AppDelegate.m+h:
(showInspectorWindow:): New method
(showBreakpointWindow:): Make this toggle window visibility rather than just always bring to front
* Source/DebuggerController.m+h: Create ivar for the inspector and synth the property
* English.lproj/Debugger.xib: Hook up the outlet
* English.lproj/MainMenu.xib: Add menu item

Add a variable value inspector

* English.lproj/Debugger.xib: Needed to remove the "Content" binding to make this work. Added a foating HUD window.

Update version to 1.2.1

* Info.plist

Add the public key for Sparkle updates

* Info.plist: Add the key file entry
* dsa_pub.pem: New file
* MacGDBp.xcodeproj: Project updates for keyfile

Update Sparkle to be a vanilla build now that we properly use CFBundleVersion

Update the project to use Gitcrement versioning

* MacGDBp.xcodeproj

Updated Sparkle to the latest bzr version

Fixed a segfault crash that would occur if you stepped at the end of a script

* Source/GDBpConnection.m:
(stepIn): Update the status before creating the stack frame so we know if we're connected or not
(stepOut): ditto
(stepOver): ditto

When writing the temporary file to use for highlighting, use NSUTF8StringEncoding rather than NSASCIIStringEncoding

* Source/BSSourceView.m:
(setString:asFile:)

Don't include the final .0 in 1.2

* Info.plist

Convert the run command to use the StackFrame system

* Source/GDBpConnection.m+h:
(run): Now returns a StackFrame object
(processData:): Return nil if the given data is nil
(createStackFrame): If we get an empty NSXMLDocument for the stack, return nil
(updateStatus): If the status is nil, the debugger is stopped
* Source/DebuggerController.m:
(run): Use the stack frame
* Source/SocketWrapper.m:
(receive): If the call to recv() returns -1 (error), return nil string

Merge branch 'path-replacement'

Conflicts:
CHANGES
Source/AppDelegate.m

The breakpoints window will now remember if it was opened or closed

* English.lproj/Breakpoints.xib: Bind the visible status to NSUserDefaults
* Source/AppDelegate.m:
(load): Add the default value for BreakpointsWindowVisible stdudef
* Source/BreakpointController.m:
(init): Only order the window back if BreakpointsWindowVisible is true

Bumping the version number to 1.2.0

* Info.plist

Add a changelog entry for the path replacements prefs

Add a change to the changelog

When sending breakpoints to Xdebug, use the [transformedPath]

* Source/GDBpConnection.m:
(addBreakpoint:): Use [transformedPath] instead of [file]

Add the actual path replacement procedure and flip/rename the columns in the preferences

* English.lproj/Preferences.xib: Flip and rename the path columns
* Source/Breakpoint.m+h:
(transformedPath): New method

Add a custom NSArrayController for the paths preferences so we can customize the default dictionary values

* English.lproj/Preferences.xib: Update the bindings
* Source/PreferencesPathsArrayController.h+m: New files
* MacGDBp.xcodeproj/project.pbxproj: Project updates for new files

Add the path management bindings and array controller

* English.lproj/Preferences.xib: Hook up the interface using bindings and NSUserDefaultsController
* Source/AppDelegate.m:
(load): Add a default for the PathReplacements user defaults

Design the paths replacement interface

* English.lproj/Preferences.xib: Design the paths panel
* Source/PreferencesController.m:
(showPreferencesWindow): Center the window before opening

Implement preferences window resizing

* Source/PreferencesController.h: Add blankView ivar
* Source/PreferencesController.m: Create private interface for resizing
(init): Create the blankView
(dealloc): New method
(awakeFromNib): New method
(showGeneral:): Call the resize method
(showPaths:): ditto
(resizeWindowToSize:): New private method

Add the paths replacement panel but don't implement anything in it

Implement a toolbar for the preferences window

* Source/AppDelegate.m:
(showPreferences:): Don't call methods on the [prefs window] anymore, but [showPreferencesWindow]
* Source/PreferencesController.m+h: Add toolbar outlet ivars
(showPreferencesWindow): New method
(showGeneral:): New method
(toolbarSelectableItemIdentifiers:): New method

Adding a CONTRIBUTORS file

Word wrap CHANGES

Show the variables in all contexts instead of just Locals. Fixes #147.

Patch partial from Nicola Ferruzzi.

* Source/StackFrame.m+h: Change "contexts" to "variables"
(initWithIndex:withFilename:withSource:atLine:inFunction:withContexts:): Renamed to be ...withVariables:
* Source/GDBpConnection.m:
(createStackFrame): Collect all the contexts into an array and send that to StackFrame
* English.lproj/Debugger.xib: Rebind to simply "variables"

When the debugger connects, automatically step in to the first frame to make the debugger look active

* Source/DebuggerController.m+h:
(startDebugger): New method
* Source/GDBpConnection.m:
(socketDidAccept:): Call the -[startDebugger] method

Updating the changelog for 1.2.0

* CHANGES

Happy new year! Bump copyright.

Highlighting of the currently debugged file will now get the source from Xdebug rather than reading local files

* Source/BSSourceView.m+h:
(setString:asFile:): New method that will highlight strings rather than files
(scrollToLine:): Change the sanity check to be based off of text in the textStorage, rather than if a file has been set
* Source/DebuggerController.m:
(updateSourceViewer): Use the new setString:asFile: instead of just setFile:

Merge branch 'refactoring'

Conflicts:
English.lproj/Debugger.xib

Fixed a bug where stepIn would remove the current stack frame if the file was the same but a function call was made

* Source/StackFrame.m:
(isShiftedFrame:): A frame is shifted if it is in the same file AND it is still in the same function

Renaming registers to variables

We need to keep variables expanded across changing stack positions

* Source/DebuggerController.m:
(setRegister:): Removed
(tableViewSelectionDidChange:): Call [expandRegisters]
(expandVariables): New private method
* Source/DebuggerController.h: Header updates

Fix a couple display issues and a crash

* Source/DebuggerController.m:
(resetDisplays): Clear all the items in the stackController.stack
(updateSourceViewer): If the selection is empty, do not try to clear it. Also, tell the textView to repaint.

Get the source code from the debugger engine in [GDBpConnection(Private) createStackFrame]

* Source/GDBpConnection.m:
(createStackFrame): Use the source GDBp command to get the source code for the stack frame

Remove -[DebuggerController setStatus:]

* Source/DebuggerController.h: Header updates
* Source/DebuggerController.m:
(awakeFromNib): Set the window's title and remove the call to [setStatus:]
(setStatus:): Removed
(setError:): Remove call to [setStatus:]
* Source/GDBpConnection.m:
(initWithPort:session:): Set the status to "Connecting"

Use automatic validation of UI items for the toolbar buttons, rather than manually enabling/disabling them

* Source/DebuggerController.h: Remove the outlets for the toolbar items
* Source/DebuggerController.m:
(validateUserInterfaceItem:): Validate the reconnect button
(setStatus:): Remove the block of code that sets button states
(updateStackViewer): ditto
* English.lproj/Debugger.xib: Remove the outlets and set all the toolbar items to autovalidate

Call -[resetDisplays] when we reconnect

* Source/DebuggerController.m:
(reconnect:): Call resetDisplays

Use bindings to set the register controller's contentArray

* English.lproj/Debugger.xib

Remove all references of the window controller from GDBpConnection

* Source/GDBpConnection.h: Removed the windowController ivar and prop
* Source/GDBpConnection.m:
(initWithWindowController:port:session): Renamed to -[initWithPort:session:]
(dealloc): No more windowController
(socketDidAccept:): Change a -[refreshStatus] to an -[updateStatus]
(reconnect): Don't make a call on windowController
* Source/DebuggerController.m:
(init): Use the updated init method for GDBpConnection

Remove the model-updating-controller register variable code

* Source/GDBpConnection.m:
(refreshStatus): Removed
(run): Call -[updateStatus] and not -[refreshStatus]
(stepIn): ditto
(stepOut): ditto
(stepOver): ditto
(updateStackTraceAndRegisters): Removed
(createStackFrame): Fetch the contexts and variables
* Source/GDBpConnection.h: Header updates

Set the file column to truncate head, not truncate tail

* English.lproj/Debugger.xib

One more instance of calling -[setStatus:] that needs to change

* Source/GDBpConnection.m:
(reconnect): Change the ivar rather than calling setStatus

Rather than having GDBpConnection tell the window controller to change status, cache the status as an ivar and bind to it

* Source/GDBpConnection.h: Define the status ivar and make it a prop
* Source/GDBpConnection.m:
(refreshStatus): Remove most of the status-updating code
(updateStatus): New method to fetch and set the status ivar
* English.lproj/Debugger.xib: Bind the status text to GDBpConnection's new status ivar

Use our new error system

* Source/GDBpConnection.m:
(processData:): Call -[errorEncountered]

Create an error system that follows MVC

* Source/DebuggerController.m:
(init): Register ourselves as an observer for the error notif type
(handleConnectionError:): New method to handle the error notifs
* Source/GDBpConnection.h: Forward-declare kErrorOccurred
* Source/GDBpConnection.m:
(errorEncountered:): Post the notification

Remove all of the old stack system

* Source/DebuggerController.h: Remove stackController2 and stack ivars
* Source/DebuggerController.m:
(validateUserInterfaceItem:): Update to use stackController.stack for -[count]
(resetDisplays): Remove the call to stackController2
(setStack): Removed
(stepIn:): Call -[updateStackViewer]
(stepOut:): ditto
(stepOver:): ditto
(updateSourceViewer): Use our new stackController
(updateStackViewer): New method
* Source/GDBpConnection.m:
(updateStackTraceAndRegisters): Remove the block of code that used to update the stack

Update the bindings for the stack viewer to use our new StackController system

* English.lproj/Debugger.xib: Redo the bindings
* Source/DebuggerController.h: Add stackArrayController ivar
* Source/DebuggerController.m:
(awakeFromNib): Set the sort descriptors
(stepIn:): Rearrange the stackArrayController
(stepOut:): ditto
(stepOver): ditto

The StackFrame index will always be 0 in -[GDBpConnection createStackFrame], so we need to advance it in -[StackController pop] and -[push:]

* Source/GDBpConnection.m:
(createStackFrame): Don't bother getting the "level" property, it will always be 0
* Source/StackController.m:
(pop): Decrease all of the frames' counter
(push:): Increase all of the frames' counter

We need to pop the stack twice when stepOut is called

* Source/DebuggerController.m:
(stepOut): Pop the stack twice

Start using our new StackFrame and StackController classes as struts

* Source/DebuggerController.h: Add the stackController ivar
* Source/DebuggerController.m:
(init): Initialize the stackController
(dealloc): Release stackController
(stepIn:): Pop and push the stackController appropriately
(stepOut:): ditto
(stepOver:): ditto
* Source/GDBpConnection.h: -[stepIn] -[stepOut] and -[stepOver] now all return StackFrame objects
* Source/GDBpConnection.m:
(stepIn): Generate and return the frame
(stepOut): ditto
(stepOver): ditto
(createStackFrame): New private method
* Source/StackController.m+h:
(peek): New method
* Source/StackFrame.m+h:
(isShiftedFrame:): New method
(description): Implemented

Refactor the DebuggerController's "stackController" ivar to be named "stackController2"

Add the StackController class

* Source/StackController.m+h: New files
* MacGDBp.xcodeproj: Project updates for new files

Adding the StackFrame class

* Source/StackFrame.m+h: New files
* MacGDBp.xcodeproj: Project updates

Reorganize the project files to separate connection from debugger classes

* MacGDBp.xcodeproj

Update version number

* Info.plist

Have the debugger and breakpoints windows remember their size and location

* English.lproj/Breakpoints.xib: Set autosave name
* English.lproj/Debugger.xib: ditto
* Source/DebuggerController.m:
(awakeFromNib): Do not call [window center] anymore

Saved breakpoints (or any breakpoint) that had a file that does not exist would crash MacGDBp

* Source/BSSourceView.m:
(setFile:): If the file does not exist, simply display an empty string
(scrollToLine:): If the file does not exist, return

Update the version to 1.1.1

* Info.plist

Allow multiple selection and removal of breakpoints

* English.lproj/Breakpoints.xib: Allow multiple selection
* Source/BreakpointController.m:
(removeBreakpoint:): Remove the selection's entirety, instead of the first element

Fix a bug where breakpoints would be recreated exponentially after their removal

* Source/BreakpointManager.m:
(removeBreakpointAt:inFile:): Need to call -[removeObject:] instead of -[addObject:]

Add the bug numbers to the change log

* CHANGES

Preferences should be set in +load rather than +initialize, as we can’t rely on AppDelegate receiving a message before any other objects (In this case, DebuggerController was being created first, leading to sockets without the correct default port number).

* Source/AppDelegate.m:
(initialize): Change to load

Changing the version to be 1.1

* Info.plist

Keep breakpoints in the preferences so they are restored at launch

* Source/BreakpointManager.m+h: Add a savedBreakpoints ivar to hold the dictionarys
(addBreakpoint:): Add the breakpoint to the NSUserDefaults
(removeBreakpointAt:inFile:): Remove the breakpoint from NSUserDefaults

Add a CHANGES file to manage the change log

* CHANGES

Fixing a memory leak

* Source/DebuggerController.m:
(gutterClickedAtLine:forFile:): The breakpoint (bp) sent to BreakpointManager is over-retained

Check and see if stderr has any data on it when syntax highlighting. If so, only show plain text.

* Source/BSSourceView.m:
(initWithFrame): Register to be an observer of the file handle reader notification
(setFile:): Add another pipe for stderr, and read in background from it
(errorHighlightingFile:): New method to handle the notification

Code formatting