<WRAP centeralign round box>
<WRAP><color red><fs 200%>Corning Community College</fs></color></WRAP>
<WRAP><fs 150%>CSCS2320 Data Structures</fs></WRAP>
</WRAP>

======Project: Singly-Linked List of Nodes (SLL0)======

=====Errata=====
This section will document any updates applied to the project since original release:

  * __revision #__: <description> (DATESTAMP)

=====Objective=====
We've made it to lists! Time to start applying nodes to more elaborate manipulations, all while contained within our new (singly-linked) list implementation!

=====Reference=====
If you haven't done so yet, you absolutely, positively, MUST watch this video: http://www.youtube.com/watch?v=5VnDaHBi8dM

=====Background=====
This connected node concept will be with us for the rest of the semester.

The trick will be how we are connecting and manipulating these nodes which defines the theme of a particular activity.

As you encountered in the introductory projects, we've been connecting nodes into sequential list organizations (what we refer to, conceptually, as a **linked list**).

There are, however, many distinctions of linked lists... so we tend to add on a lot of qualifiers to better identify the particular type of linked list we are implementing/using.

As our nodes up to this point have only contained a single Node pointer for connection (the "right" pointer), we have what are called "singly-linked nodes".

Therefore, generically, we are creating a "Singly-Linked List"; but we should also be specific about what we are creating a singly-linked list of-- so the full description will be "List of Singly-Linked Nodes".

Confusing naming terminology? Oh, just wait... we've barely gotten started.

====organizational unit====
We've already experienced lists.. in concept they are nothing more than ensuring nodes are connected together and manipulated in predefined ways (think about insertion, for instance).

In practice, though, we will make our lives easier by introducing an organizational unit to aid us in managing our linked lists. It is important to note, that what we are going to do, while common practice, does not in and of itself make a linked list... all we are doing is making our access of the linked list **easier**... that's it (and you're welcome).

Just as the node struct is an organizational unit for the data and style of connecting (nodes would be useless if we had no need to put something of value in them... nor would they be of use if we couldn't connect them in various ways).

So, we're just going to add another layer on top-- we're going to create a List struct, which will house some of the important managerial/administrative data about our list. Specifically, in the current context, the Node pointers referencing our list's starting and ending locations (so we'll have one container variable managing the details of our list, which will make associative manipulation all the easier, if only at the cost of a little more typing).

I give you, our list struct:

<code c>
struct list {
    struct node *lead;
    struct node *last;
};
</code>

All this does, as I said, is establish a container to better manage what has (up to this point) been individually managed variables. Hopefully you've been seeing how valuable the node container has been for managing node-related details-- this list container will do the same for the details we need to manage as a result of manipulating nodes.

To make our lives easier, lets toss in a **typedef** as well:

<code c>
typedef struct list List;
</code>

Now, we apply similar operations to our List container as we would individual Nodes... when we **insert()**, for instance, we will be passing our List container around, which will reduce the number of parameters needed.

To address these aspects, we just access the struct elements as we have all along (as always, be mindful of a particular struct's contents):

<code c>
    List *myList = mklist();
    Node *tmp    = mknode(7);
    
    myList = insert(myList, myList -> lead, tmp); // insert tmp before initial node of myList
</code>

And we can access the value contained in the list's initial node as follows: myList -> lead -> info

We do need to be mindful of the organization we are creating- as part of implementing this, we'll have various list management functions at our disposal (insert, append, sort, getpos, obtain, etc.)... so we should restrict our list manipulation to those functions (reduce the number of cooks in the kitchen). This is another aspect of relinquishing our default tight fist of control... it may take some getting used to, but as you start seeing the bigger picture, you'll see what a big favor we're doing for ourselves here.

=====Procedure for bootstrapping=====

====Obtain====
On Lab46, change into your **sln1** directory (I'll use **~/src/SEMESTER/DESIG/sln1/** in my examples):

<cli>
lab46:~$ cd src
lab46:~/src$ cd SEMESTER/DESIG
lab46:~/src/SEMESTER/DESIG$ cd sln1
lab46:~/src/SEMESTER/DESIG/sln1$ 
</cli>

**NOTE:** At this point you should be completed with the **sln1** project.

If you are done, and a **make help** shows an **upgrade-sll0** option being available:

<cli>
lab46:~/src/SEMESTER/DESIG/sln1$ make help
****************[ Data Structures Node Implementation ]*****************
** make                     - build everything (libs, units, apps)    **
** make debug               - build everything with debug symbols     **
** make check               - check implementation for validity       **
**                                                                    **
** make libs                - build all supporting libraries          **
** make libs-debug          - build all libraries with debug symbols  **
** make apps                - build unit tests                        **
** make apps-debug          - build unit tests with debugging symbols **
** make units               - build unit tests                        **
** make units-debug         - build unit tests with debugging symbols **
**                                                                    **
** make save                - create a backup archive                 **
** make submit              - submit assignment (based on dirname)    **
**                                                                    **
** make update              - check for and apply updates             **
** make reupdate            - re-apply last revision                  **
** make reupdate-all        - re-apply all revisions                  **
**                                                                    **
** make upgrade-sll0        - upgrade to next project (sll0)          **
** make clean               - clean; remove all objects/compiled code **
** make help                - this information                        **
************************************************************************
lab46:~/src/SEMESTER/DESIG/sln1$ 
</cli>

We can proceed with bootstrapping the **sll0** project:

<cli>
lab46:~/src/SEMESTER/DESIG/sln1$ make upgrade-sll0
Cleaning out object code    ... OK


Project backup process commencing

Taking snapshot of current project (sln1)      ... OK
Compressing snapshot of sln1 project archive   ... OK
Setting secure permissions on sln1 archive     ... OK

Project backup process complete

Commencing upgrade process from sln1 to sll0

Creating project sll0 directory tree           ... OK
Copying your code to sll0 project directory    ... OK
Copying new sll0 files into project directory  ... OK
Synchronizing sll0 project revision level      ... OK
Establishing sane file permissions for sll0    ... OK

Upgrade Complete! You may now switch to the ../sll0 directory

lab46:~/src/SEMESTER/DESIG/sln1$ 
</cli>

As you can see from the last line: **You may now switch to the ~/src/SEMESTER/DESIG/sll0 directory**

So let's do it:

<cli>
lab46:~/src/SEMESTER/DESIG/sln1$ cd ../sll0
lab46:~/src/SEMESTER/DESIG/sll0$ 
</cli>

====Overview====
You'll see various files and directories located here (one regular file, **Makefile**, and 6 directories). The directory structure (note, not all these directories may yet be present) for the project is as follows:

  * **app**: subdirectory tree containing applications/demos using Data Structures implementations
    * **node**: location of node end-user applications
  * **bin**: compiled, executable programs will reside here
  * **inc**: project-related header files (which we can **#include**) are here
  * **lib**: compiled, archived object files (aka libraries) will reside here
  * **src**: subdirectory tree containing our Data Structure implementations
    * **node**: location of our node implementation
    * **list**: location of our linked list implementation (manipulation of nodes)
    * **stack**: location of our stack implementation (manipulation of  lists)
    * **queue**: location of our queue implementation (a different manipulation of lists)
    * ...
  * **unit**: subdirectory tree containing unit tests, helping to verify correct implementation
    * **node**: node-related unit tests will be here
    * **list**: list-related unit tests will be here
    * ...

=====Operating=====

The project is driven by a fleet of optimized **Makefile**s, which will facilitate the compiling process for us.

Each Makefile plays a unique role (the closer the Makefile is to the source code, the more specialized it becomes).

The base-level Makefile is used to enact whole-project actions, such as initiating a compile, cleaning the project directory tree of compiled and object code, submitting projects, or applying bug-fixes or upgrading to other projects.

Running **make help** will give you a list of available options:

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make help
****************[ Data Structures List Implementation ]*****************
** make                     - build everything (libs, units, apps)    **
** make debug               - build everything with debug symbols     **
** make check               - check implementation for validity       **
**                                                                    **
** make libs                - build all supporting libraries          **
** make libs-debug          - build all libraries with debug symbols  **
** make apps                - build unit tests                        **
** make apps-debug          - build unit tests with debugging symbols **
** make units               - build unit tests                        **
** make units-debug         - build unit tests with debugging symbols **
**                                                                    **
** make use-test-reference  - use working implementation object files **
** make use-your-own-code   - use your own implementation code        **
**                                                                    **
** make save                - create a backup archive                 **
** make submit              - submit assignment (based on dirname)    **
**                                                                    **
** make update              - check for and apply updates             **
** make reupdate            - re-apply last revision                  **
** make reupdate-all        - re-apply all revisions                  **
**                                                                    **
** make clean               - clean; remove all objects/compiled code **
** make help                - this information                        **
************************************************************************
lab46:~/src/SEMESTER/DESIG/sll0$ 
</cli>

In general, you will likely make the most frequent use of these options:

  - **make**: just go and try to build everything
  - **make debug**: build with debugging support
  - **make clean**: clean out everything so we can do a full compile

Most of what you do will be some combination of those 3 options.

====Project Submission===
When you are done with the project and are ready to submit it, you simply run **make submit**:

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make submit
...
</cli>
 
====Bugfixes and Updates====
Sometimes, a typo or other issue will be uncovered in the provided code you have. I will endeavor to release updates which will enable you to bring your code up-to-date with my copy.

When a new update is available, you will start seeing the following appear as you go about using make:

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make
*********************************************************
*** NEW UPDATE AVAILABLE: Type 'make update' to apply ***
*********************************************************
...
lab46:~/src/SEMESTER/DESIG/sll0$ 
</cli>

When this occurs, you may want to perform a backup (and/or commit/push any changes to your repository)-- certain files may be replaced, and you do not want to lose any modifications you have made:

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make save
Archiving the project ...
Compressing the archive ...
Setting Permissions ...
lab46:~/src/SEMESTER/DESIG/sll0$ 
</cli>

Once you have done that, go ahead and apply the update (note this output is from the **node0** project update, so you will not see the exact same output):

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make update
Update 1 COMMENCING
Update 1 CHANGE SUMMARY: Fixed base and other Makefile typos
    Please reference errata section on project page for more information
Update 1 COMPLETE
Updated from revision 0 to revision 1
lab46:~/src/SEMESTER/DESIG/sll0$ 
</cli>

At this point your code is up to date (obviously the above output will reflect whatever the current revision is).

====error reporting====
To facilitate debugging and correction of errors and warnings in your code at compile time, such compiler messages will be redirected to a text file called **errors** in the base of the project directory.

You can view this file to ascertain what errors existed in the last build of the project.

With each new project build, this file is overwritten, so you always have the most up-to-date version of compile-time information.

=====Project Overview=====

====header file====
In **inc/**, you will find a new file: **list.h**

Take a look inside, and ask any questions to get clarification:

<code c 1>
#ifndef _LIST_H
#define _LIST_H

#include "node.h"                       // list relies on node to work

struct list {
    Node *lead;                         // pointer to start of list
    Node *last;                         // pointer to end of list
};
typedef struct list List;               // because we deserve nice things

List *mklist(void  );                   // create/allocate new list struct
List *insert (List *, Node *, Node *);  // add node before given node
void  displayf(List *, int);            // display list from beginning to final node
int   getpos(List *, Node *);           // retrieve position from given node
Node *setpos(List *, int   );           // seek to indicated node in list

#endif
</code>

This is your API for the list library. In order to use the list library three things need to happen:

  * you must **#include "list.h"** (generally already done you in this project)
  * you must link against **lib/liblist.a** (the Makefiles take care of this for you)
  * you must call the functions providing the appropriate arguments and handling the return values

====list library====
In **src/list/**, you will find 4 C files (containing a total of 5 functions):

  * **displayf.c** - which will display the contents of your list from start to end
  * **insert.c**   - which will house the list insert function
  * **mk.c**       - which will handle the creation of new lists
  * **pos.c**      - helper functions to locate list node positions and indices

Skeletons of functions has been provided. Fill in the gaps, and implement the functions that have been left blank.

Take a look at the code there. These are the files that contain functions which will be compiled and archived into the list library (**liblist.a**) we will be using in this and future projects.

Figure out what is going on, make sure you understand it.

**NOTE:** None of these files denote an entire runnable program. These are merely standalone functions. The various programs under the **app/** and **unit/** directories will use these functions in addition to their application logic to create complete executable programs.

You will also notice there are function prototypes for these list library functions in the **list.h** header file, located in the **inc/** subdirectory, which you'll notice all the related programs you'll be playing with in this project are **#include**ing.

====List library unit tests====
In **unit/list/**, you will find 4 files (along with a **Makefile**):

  * **unit-mklist.c** - unit test for **mklist()** library function
  * **unit-displayf.c** - unit test for **displayf()** library function
  * **unit-insert.c** - unit test for **insert()** library function
  * **unit-getpos.c** - unit test for **getpos()** library function
  * **unit-setpos.c** - unit test for **setpos()** library function

These are complete runnable programs (when compiled, and linked against the list library, which is all handled for you by the **Makefile** system in place).

Of particular importance, I want you to take a close look at:

  * the source code to each of these unit tests
    * the purpose of these programs is to validate the correct functionality of the respective library functions
    * follow the logic
    * make sure you understand what is going on
    * ask questions to get clarification!
  * the output from these programs once compiled and ran
    * analyze the output
    * make sure you understand what is going on
    * ask questions to get clarification!

=====Building the code=====
You've made changes to a file in **src/list/**, and are ready to see your results. What do we do?

First, let's have a second terminal open and logged into lab46. Put it in the base directory of the **sll0** project:

<cli>
lab46:~$ cd src/SEMESTER/DESIG/sll0
lab46:~/src/SEMESTER/DESIG/sll0$  
</cli>

Keep your other terminal in the **~/src/SEMESTER/DESIG/sll0/src/list/** directory, so you can more effectively make changes.

====cleaning things out====
If you've already ran **make** to build everything a few times, you may want to clean things out and do a fresh compile (never hurts, and might actually fix some problems):

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make clean
...
lab46:~/src/SEMESTER/DESIG/sll0$ 
</cli>

====compile project====
Next, compile the whole project

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make
...
</cli>
====Our binaries====
Compiled executables go in the **bin** directory, so if we change into there and take a look around we see the various executables built (both new with this project as well as migrated code from previous projects).

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ cd bin
lab46:~/src/SEMESTER/DESIG/sll0/bin$ ls
...
lab46:~/src/SEMESTER/DESIG/sll0/bin$ 
</cli>

====Run the program====
To run **unit-insert**, we'd do the following (specify a relative path to the executable):

<cli>
lab46:~/src/SEMESTER/DESIG/sll0/bin$ ./unit-insert
</cli>

The program will now run, and do whatever it was programmed to do.

=====Reference Implementation=====
As the layers and complexities rise, narrowing down the source of errors becomes increasingly important.

If **unit-insert** isn't working, is it because of a problem there, in your **insert()** function, or in one of the node functions it calls, such as **mknode()**?

To aid you in your development efforts, you now have the ability to import a working implementation of previous project functions into your current project for the purposes of testing/debugging purposes.

====Using the test reference implementation====
You'll notice that, upon running **make help** in the base-level Makefile, the following new options appear (about halfway in the middle):

<cli>
**                                                                    **
** make use-test-reference  - use working implementation object files **
** make use-your-own-code   - use your node implementation code       **
**                                                                    **
</cli>

In order to make use of it, you'll need to run **make use-test-reference** from the base of your **sll0** project directory, as follows:

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make use-test-reference
...
NODE reference implementation in place, run 'make' to build everything.
lab46:~/src/SEMESTER/DESIG/sll0$ 
</cli>

You'll see that final message indicating everything is in place (it automatically runs a **make clean** for you), and then you can go ahead and build everything with it:

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make
...
</cli>

**__Debugging__:** When using the test reference implementation, you will not be able to debug the contents of the test reference implementation functions (the files provided do not have debugging symbols added), so you'll need to take care not to step into these functions (it would be just like stepping into **printf()**. You can still compile the project with debugging support and debug (as usual) those compiled functions (ie the stack functions).

====Reverting back to using your code====
If you were trying out the reference implementation to verify queue functionality, and wanted to revert back to your own code, it is as simple as:

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make use-your-own-code
Local node implementation restored, run 'make clean; make' to build everything.
lab46:~/src/SEMESTER/DESIG/sll0$ 
</cli>

Just to be clear: the reference implementation is not some magic shortcut getting you out of doing this project; it merely gives you a glimpse into how things are working, or should be working, provided your node library is complete and fully functional.

=====Expected Results=====
To assist you in verifying a correct implementation, a fully working implementation of the node library and list library (up to this point) should resemble the following:


====list library (so far)====
Here is what you should get for all the functions completed so far in the list library:

<cli>
lab46:~/src/SEMESTER/DESIG/sll0$ make check
====================================================
=    Verifying Singly-Linked List Functionality    =
====================================================
  [mklist] Total:   5, Matches:   5, Mismatches:   0
  [insert] Total:  11, Matches:  11, Mismatches:   0
[displayf] Total:  10, Matches:  10, Mismatches:   0
  [getpos] Total:   8, Matches:   8, Mismatches:   0
  [setpos] Total:   9, Matches:   9, Mismatches:   0
====================================================
 [RESULTS] Total:  43, Matches:  43, Mismatches:   0
====================================================
lab46:~/src/SEMESTER/DESIG/sll0$ 
</cli>
=====Submission=====
{{page>haas:fall2021:common:submitblurb#DATA&noheader&nofooter}}