4
edits
Changes
m
== Team Temporary Name ==
== Coding Standards ==Coding standards are important if we want code to be readable. Now the jist of these rules is that they're "common sense" with readability in mind. The most important section is the commenting section as it is basically arbitrary while all the others should be more or less common sense. In any case, the entire thing is up now have their own page [[OOP344_Temporary_CodingStandards | here for reference purposes. We should all attempt to follow these guidelines when writing code.<br/>]]!<br/>While no one will be prosecuted or killed if they forget one or more of these, the others will gently '''remind''' the person in question to '''follow the guidelines-northWind87''' :)
=== Statement Notation ===The first left parenthesis on a function declaration should open immediately after We had another meeting last Thursday and even though we didn't have CJ with us, it was still effective. For now, the function name while way forward seems relatively clear. Out of the first left parenthesis meeting, we've decided on a loop declaration should open one space after the loop declaration.<br />''' ie Functionsfollowing project requirements: '''<pre>int hello(char goodbye(void getQuestion(</pre>
''' ie Loops# An IO_Control class will be implemented that will handle the normal operations of the text editor. This class will hold the one true instance of the IO_Menumgr class and will be responsible for interfacing with the menu. The IO_Form class will be modified to hold an IO_Control pointer to its IO_Control owner.# An IO_Settings class will be implemented (already complete) that will save, load, and give access to all subsequent project settings such as word wrapping. The classes IO_Field and IO_Control will each hold a pointer an IO_Settings instance. IO_Form will be responsible for passing the IO_Settings object to newly created IO_Fields from its IO_Control owner.# IO_Filemgr will be further developed by Ausley. It will be able to open file records and control their read and write operations.# Some extension classes will be developed. These classes will be derived from the other generic control classes (eg IO_Form, IO_Menu, etc...) and will be specific configurations of those classes. For example, a derivation of IO_Form will be preferences window known as IO_PrefForm. Currently, the list of extension classes slated for creation is as follows: '''<pre#* IO_EditorForm (IO_Form ->IO_EditorForm)while #* IO_PrefForm (IO_Form -> IO_PrefForm)for #* IO_MsgBox (IO_Form -> IO_MsgBox)do #* IO_BtnGrp (</preIO_Menu ->IO_BtnGrp)
In the same senseSo there we go, the first left parenthesis should immediately follow the function name when a function is calledhopefully we can whip this stuff out in short order.<br/>''' ie ''' <code>x = getInt(), someInt = y + bigSum(y, r)</code>
=== Code Blocks ===Both function blocks and loop blocks should open on the same line as the declaration statement preceding them; however, function blocks should open immediately after the last right parenthesis while loop blocks should open one space after the last right parenthesis.<br />''' ie Functions: -northWind '''<pre>int hello(){char goodbye(){void getQuestion(void){</pre>
''' ie Loops== December 07, 2009 : '''<pre>while (var < 15) {for (int i The Deadline Approaches and The Rise of The New World Order == 0; i < 15; i++) {do (blah) {</pre>
=== Comment Blocks ===All functions should have Been a comment block preceding them which should explain what the function does in while since our last announcement but here we go, a few brief sentencesthings to go over:Firstly, what parameters it receives with each parameter having a section preceded by <code>@param</code>, and anything that the function may return preceded by <code>@return</code> at the end I'd like to say on behalf of the block. Try to keep things lined up so that theyeveryone - '''Congratulations!'''re easier to read.
Here is an example from Assignment 1 utilizing the io_strcpy() function:<pre>/*Copies a given number As of characters now, nearly all required functionality has been implemented. Everything from one string Frame to another. *Self copying Textedit is allowed. Does not stop at null-terminatornow working (with Textedit nearly working, always copies *much thanks to JP for all his hard work on that and the given number of charactersForm). * *@param const char* src address from which I personally feel that this is a great accomplishment considering that we are planning to copy characters. *@param char* dest address to which characters will be copied. *@param int n number move forward ahead of characters to copy. * *@return the address of dest if copy was successful, NULL otherwise. */char* io_strcpy(char* dest, const char* src, int n){</pre>Commenting within the function should be generally organized, that's about it for in-function commentingwhat is actually required and into foreign territory.
$LastChangedBy :: $ $LastChangedDate :: $ $Rev :: $ ##########################################################################*/</pre>Preliminarily, I've added some of the features that we would like to have in this editor by January; they are all up for discussion as we must now re-assign duties once again. I'm hoping that we can minimally have save and load finished as they are fairly simple but I mean who knows. Anyhow, I look forward to seeing you all on Thursday, we have some discussing to do.
Now SVN will actually automatically change ''' -northWind ''' == November 04, 2009 : Stefan Butnaru is Officially Out == Hello, this announcement is to simply inform all that Stefan Butnaru has officially left the "last modified" lines group as you commit files he plans to drop the OOP344 course in favor of the repository COBOL courses. I have already removed his name from the group pages, and his task has now been released and this can be picked up by anyone who wants it once their current task is done by using the following lines and the svn:keywords property:completed.<pre> $LastChangedBy :: $''' -CloudScorpion ''' $LastChangedDate :: $ $Rev == October 31, 2009 :: $Meeting Tuesday and Wednesday ==</pre>LastChangedBy Hey guys, our next group meeting will show be in the last person to school on Tuesday after class; for details, please see the Meetings section. As well, we have modified an IRC meeting with Fardad on Wednesday at 5pm. In the filetime being, LastChangedDate please start working on your assigned sections. Consider the part of A2 that is currently available online to be final; it will show not need to be revised so please work with the date that outline currently available. Let's get some work done by Tuesday guys because we don't have too long to finish this file was last modified on, thing and Rev will indicate the revision at which ideally I'd like this beginning section to be finished by Friday of this file was last changedcoming week. As usual, if there are any discrepancies or if anyone needs some help or if you want to help others then please let me know. See you soon!
The svn:keywords property has already been globally set and propagated so it's in full use right now and all files that need a header should have one in the specified format.
<br/><br/>
That's about it folks, feel free to add or remove anything if you feel so compelled but please consult the rest of the group first if it is a major change.<br/>
=== October 25, 2009 : IRC meetings ===
== Meetings ===== Tuesday October 27 ===
→Task schedule
[[OOP344]] - [[OOP344 Student List]] - [[OOP344 Teams]] - [[OOP344 Assignment One]] - [[OOP344 Assignment Two]] - [[OOP344 IRC Schedules 20093 | OOP344 IRC Schedules]]<br />
''' Group Contact/Team Leader: Hasan '''
! Last Name !! Name !! Seneca Username !! Section !! Blog Url !! IRC Nick !! Current Task !! SVN Username
|-
| Butnaru Hughes || Stefan Joseph || sbutnaru jphughes || B || [http://cr4zym0nkeyCloudScorpion.blogspot.com Cloudscorpion's Blog] || Fonzie CloudScorpion || - IO_Form || ops344_093svn115ops344_093svn112
|-
| Hughes Johnson || Joseph Ausley || jphughes aljohnson1 || B || [http://CloudScorpionausleyj.blogspot.com Cloudscorpion's My Blog] || CloudScorpion Johnno || - IO_Edit || ops344_093svn112ops344_093svn113
|-
| Johnson Kamal-Al-Deen || Ausley Hasan || aljohnson1 hkamal-al-deen || B || [http://ausleyjorbitalstation.blogspotwordpress.com My BlogThe Orbital Station] || Ausley_Johnson northWind87 || - LinkedList || ops344_093svn113ops344_093svn111
|-
| Kamal-Al-Deen Sandhu || Hasan Charanjit || hkamal-al-deen cssandhu || B || [http://orbitalstationcj-seneca.wordpressblogspot.com The Orbital StationBlog] || northWind87 Charanjit|| IO_Label || ops344_093svn114 |} = Task schedule = {| border="1" cellpadding="5"|+! Task Name !! Assigned to !! Due date !! Completed|-| IO_Field || JP Hughes || - || Done|-| IO_Form || JP Hughes || Thursday, 12th November || Done|-| ULinkedList || Hash Kamal-al-deen || Wednesday, 11th November || Done|-| IO_Frame || Ausley Johnson || - || Done|-| IO_Edit || Ausley Johnson || Sunday, 15th November || Done|-| IO_Vedit || Ausley Johnson || Sunday, 15th November || Done|-| IO_Label || CJ Sandhu || Thursday, 12th November || Done|-| IO_CheckList || CJ Sandhu || Sunday, 20th November || Done|-| IO_Menu || Hash Kamal-al-deen || Tuesday, 17th November || Done|-| IO_Menumgr || Hash Kamal-Al-Deen || - || Done|-| IO_Settings || Hash Kamal-Al-Deen || - || Done|-| CIOL Frame Buffer Extension || Hash Kamal-Al-Deen || - || Done|-| Linux Port || Hash Kamal-Al-Deen || - || Done|-| IO_Button || Hash Kamal-Al-Deen || - || Done|-| IO_ButtonGrp || Hash Kamal-Al-Deen || - || Done|-| IO_Box || Hash Kamal-Al-Deen || - || Done|-| IO_MsgBoxForm<br/>IO_FileForm || Hash Kamal-Al-Deen || - || Done|-| IO_DirBrowser || Hash Kamal-Al-Deen || - || IN PROGRESS|-| IO_TextEditor || JP Hughes || - || Done|-| Word Wrapper || JP Hughes || - || Done|-| IO_Filemgr || Ausley Johnson || - || DONE|-| IO_Controller || JP Hughes || - || DONE|-| IO_EditorForm || JP Hughes || - || ops344_093svn111DONE
|-
| Sandhu IO_PrefForm || Charanjit ? || cssandhu - || PLANNED|-| Highlight Functionality || ? ||- | B |PLANNED| [http:-| Copy/Paste || ? || - || PLANNED|-| Search/cj-seneca.blogspot.com Blog] Replace || Charanjit? || - || ops344_093svn114PLANNED
|}
=Announcements == Naming Conventions ===* ''' Camel Notation ''' should be used for variable names and function names ** ''' ie ''' <code>myVar, bigInt, getNumber(), myFunction()</code>* Class names should always be ''' First-Letter Capitalized '''** ''' ie ''' <code>TestClass, DynamicStack, PeanutButter, Hammer</code>* Compiler directives should always be written in ''' All Lowercase '''** ''' ie ''' <code>#define, #ifndef</code>* Compiler definitions should be ''' All Uppercase ''' and should only use underscore where a gap is required ** ''' ie ''' <code>IO_CTL_LARGEFILE, SOME_DEFINITION</code>* Header file defines should be preceeded and followed with ''' Two Underscores '''** ''' ie ''' <code>__CIOL_H__, __IO_FORM_H__</code>* Pointer declaration should ''' emphasize the type ''' with the <b>"*"</b> being pushed against the right side of the data type as opposed to the left side of the variable name.** ''' ie ''' <code>char* str, int* numDecember 21, void* addr</code>* Binary operators should have a space between them and their constituents ('''Note2009 :''' This does not apply to unary operators such as ++ or []).** ''' ie ''' <code>x = 7, z += y, int i = 10, judge = y > 5</code>* As well, please leave a space after every comma Meeting Results and every semicolon if something follows it.** ''' ie ''' <code>foo(int firstInt, int secondInt, int thirdInt), x The Way Forward = bugSquish(parm1, parm2), for (int i = 0; i < 10; i++)</code>* Finally, <code>void</code> should always be explicitly declared.** ''' ie ''' <code>void doStuff(void), int getInt(void)</code>
With this come a few issues: As wellwe move into uncharted waters, please ensure the effects of feature creep will become more and more apparent; I've personally felt them in much of my own work. Consider the fact that a small commented header my ULL is ~600 lines of code and the menu manager is going to hit something around 400 or 500; even IO_Menu is gargantuan at 300 lines where Fardad's menu is only something like 180 lines. This will put our total project at somewhere near the 3000+ line mark when it's finished while Fardad in the beginning of the semester planned for the top entire culmination of every file (implementation if .cpp or header if .h). It should contain information such as the file name, project name, last modified date, last modified by, etc.to be somewhere around 1600 lines of code..Using I don't know how this will affect everyone but with exams creeping right around the example corner, I feel that this might be a good time to take a bit of ciol.c a rest from this assignment 1, it should be in the following form:<pre>/* ########################################################################## Project: OOP344 Assignment 1 File Name: ciol.c File Desc.: Implementation file for console input output (CIOL) libraryand perhaps take a look back at what we have and what we want.
'''-northWind87'''
== Announcements October 30, 2009 : Upcoming Meeting & possible new meetings ===Ok guys, we have another IRC meeting at 7:00 PM on Friday October 30 (today). Fardad wants the wiki updated and blogs about the previous meeting up before the meeting at 7:00 PM. He likely wants us all to have assigned tasks by the meeting as well, which northWind and myself have already decided on, and is likely already posted or will be posted shortly after this is posted. I also think it would be a great idea to have some more independant group meetings, preferably one next week. I was not present for the last meeting, and there are some things I'd like to go over with the group, ideas and plans for the upcoming project. A meeting time we can all agree on would be prefereable, but it is not critical that all members be present. I have continued attempting to contact Stefan Butnaru but to no avail. We will have to wait and see. ''' -CloudScorpion ''' == October 27, 2009 : Coding Standards added, meeting with Fardad at 5 pm Wednesday ===
OK! It was a long write but I've added all the necessary and agreed upon coding standards. As of now they are up here as a reference for everyone. Hopefully we can stick to the guidelines, gentlemen? As usual, if there are any disagreements or discrepancies on anything please feel free to consult me and/or the group in it's entirety.
''' -northWind87 '''
As I've emailed you all, Fardad wants two IRC meetings with us during the study week so please indicate your availability (all of it, all times that you are available) during the study week here.
'''-northWind87'''
=Meetings === Study Week Availability ==Tuesday November 3 == Second meeting. We will meet Tuesday after OOP344 class as I've confirmed this date with everyone. ''' Agenda: '''* Discuss the final state of A2.* Decide on any additional features that we may want.* Design the final/altered form of our group's A2.* Plot project time-line up until November 29 which is when A2 is due.
That's about it, see you then!<br/>''Hasan:'-northWind87''' Tuesday 11am - 2pm, Wednesday 11am - 6pm, Thursday 6:30pm - 10pm, Friday 6:30pm - 10pm, Saturday 11am - 9pm
Alright guys, first meeting ever. The tentative meeting time is so far somewhere in between the afternoon (ie 1 pm) and the evening (ie 5:30 pm) so your input would be highly appreciated.<br/>
As well, we're gonna have to speak to Fardad on IRC at some point although he hasn't been on IRC and hasn't emailed me about it yet so I'll let you all know once I know more. '''-northWind87'''
= Discussion =
'''northWind87:''' Added discussion section and our first comment.