{"id":45,"date":"2008-09-16T11:16:11","date_gmt":"2008-09-16T01:16:11","guid":{"rendered":"http:\/\/www.malcolmgroves.com\/blog\/?page_id=45"},"modified":"2008-09-16T21:59:53","modified_gmt":"2008-09-16T11:59:53","slug":"ibsite","status":"publish","type":"page","link":"http:\/\/www.malcolmgroves.com\/blog\/?page_id=45","title":{"rendered":"IBSite"},"content":{"rendered":"

CodeSite 2, from Raize Software <\/a>, is a powerful debugging tool for Borland Delphi and C++Builder. The problem? Often not all of the logic in your application is contained in Delphi or C++Builder code. Some logic is often contained in Stored Procedures and Triggers. However, by itself, CodeSite will only let you trace the flow of execution to the boundary of your Delphi or C++Builder code. What goes on inside your database is pretty much a mystery to CodeSite.<\/span><\/p>\n

Well, IBSite tries to fix that. IBSite is a free extension to CodeSite 2 which allows CodeSite messages to be sent from Interbase Stored Procedures and Triggers. It comes as a collection of UDF’s (User Defined Functions), which once installed into Interbase, can be called like any other statement from Interbase SQL.<\/p>\n

Requirements<\/h3>\n

IBSite has been tested with CodeSite 2 Professional and Interbase v6.0 on Windows. I don’t think I’m taking advantage of any of the features not present in CodeSite 2 Standard, so I believe it should also work with the Standard Edition, but let me know if you strike any issues. Additionally, Interbase has had UDF support for a number of versions, so I believe it should also work with any Interbase version on Windows which supports UDF’s. As I, or others, try it out with more versions, we’ll post the results.<\/p>\n

<\/p>\n

Example:<\/p>\n

<\/span><\/h3>\n

As an example, the following test Stored Procedure:<\/span><\/p>\n

set<\/code> term # ;\r\ncreateprocedure TestCS\r\nAS<\/code>\r\nbegin<\/code>\r\n  executeprocedure csClear;\r\n  executeprocedure csCategoryColor 'clWhite'<\/code>;\r\n  executeprocedure csEnterMethod 'TestCS'<\/code>;\r\n  executeprocedure csCategory 'IBSite Test'<\/code>;\r\n  executeprocedure csAddCheckPoint;\r\n  executeprocedure csResetCheckpoint;\r\n  executeprocedure csAddCheckPoint;\r\n  executeprocedure csAddSeparator;\r\n  executeprocedure csSendMemoryStatus;\r\n  executeprocedure csSendMsg 'Msg'<\/code>;\r\n  executeprocedure csDisable;\r\n  executeprocedure csSendMsg 'Should not see this'<\/code>;\r\n  executeprocedure csEnable;\r\n  executeprocedure csCategoryColor 'clYellow'<\/code>;\r\n  if<\/code> (csEnabled() = 1) then<\/code>\r\n    executeprocedure csSendMsg 'CodeSite Already Enabled'<\/code>;\r\n  else<\/code>\r\n  begin<\/code>\r\n    executeprocedure csEnable;\r\n    executeprocedure csSendMsg 'Just Enabled CodeSite'<\/code>;\r\n  end<\/code>\r\n  executeprocedure csSendMsg 'Should see this'<\/code>;\r\n  executeprocedure csSendString 'String'<\/code>, 'Value'<\/code>;\r\n  executeprocedure csSendInteger 'Integer'<\/code>, 1;\r\n  executeprocedure csSendFloat 'Float'<\/code>, 1.1;\r\n  executeprocedure csSendNote 'This is a test note'<\/code>;\r\n  executeprocedure csWriteInteger 'First'<\/code>, 'Integer'<\/code>, 1;\r\n  executeprocedure csWriteFloat 'Second'<\/code>, 'Float'<\/code>, 1.1;\r\n  executeprocedure csWriteString 'Third'<\/code>, 'String'<\/code>, 'Value'<\/code>;\r\n  executeprocedure csWriteMsg 'Fourth'<\/code>, 'Msg'<\/code>;\r\n  executeprocedure csExitMethod 'TestCS'<\/code>;\r\nend<\/code> #\r\nset<\/code> term ; #<\/pre>\n
produces the following output in the CodeSite 2 viewer:<\/p>\n\n\n\n
<\/td>\n\"\" <\/a><\/p>\n
Click image for larger screenshot<\/div>\n<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
Currently, IBSite supports the following CodeSite 2 calls, inside your Interbase SQL code. This seems to cover most basic requirements.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
\n
CodeSite<\/div>\n<\/td>\n
\n
IBSite Equivalent<\/div>\n<\/td>\n<\/tr>\n
CodeSite.Category<\/td>\ncsCategory<\/td>\n<\/tr>\n
CodeSite.CategoryColor<\/td>\ncsCategoryColor<\/td>\n<\/tr>\n
CodeSite.AddSeparator<\/td>\ncsAddSeparator<\/td>\n<\/tr>\n
CodeSite.AddCheckpoint<\/td>\ncsAddCheckpoint<\/td>\n<\/tr>\n
CodeSite.ResetCheckpoint<\/td>\ncsResetCheckpoint<\/td>\n<\/tr>\n
CodeSite.SendMemoryStatus<\/td>\ncsSendMemoryStatus<\/td>\n<\/tr>\n
CodeSite.Clear<\/td>\ncsClear<\/td>\n<\/tr>\n
CodeSite.Enabled := True<\/td>\ncsEnable<\/td>\n<\/tr>\n
CodeSite.Enabled := False<\/td>\ncsDisable<\/td>\n<\/tr>\n
CodeSite.Enabled<\/td>\ncsEnabled<\/td>\n<\/tr>\n
CodeSite.DestinationDetails<\/td>\ncsDestinationDetails<\/td>\n<\/tr>\n
CodeSite.EnterMethod<\/td>\ncsEnterMethod<\/td>\n<\/tr>\n
CodeSite.ExitMethod<\/td>\ncsExitMethod<\/td>\n<\/tr>\n
CodeSite.SendMsg<\/td>\ncsSendMsg<\/td>\n<\/tr>\n
CodeSite.SendString<\/td>\ncsSendString<\/td>\n<\/tr>\n
CodeSite.SendInteger<\/td>\ncsSendInteger<\/td>\n<\/tr>\n
CodeSite.SendFloat<\/td>\ncsSendFloat<\/td>\n<\/tr>\n
CodeSite.SendNote<\/td>\ncsSendNote<\/td>\n<\/tr>\n
CodeSite.WriteInteger<\/td>\ncsWriteInteger<\/td>\n<\/tr>\n
CodeSite.WriteFloat<\/td>\ncsWriteFloat<\/td>\n<\/tr>\n
CodeSite.WriteString<\/td>\ncsWriteString<\/td>\n<\/tr>\n
CodeSite.WriteMsg<\/td>\ncsWriteMsg<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
<\/p>\n
History<\/h3>\n
v1.0 – 18 August 2001<\/p>\n