Browse Source

Some tweaks

stew
stew3254 3 years ago
parent
commit
a2010a47a9
  1. 69
      docs/design.md
  2. 51
      docs/design.txt
  3. 3
      docs/sample_interface.txt
  4. 60
      docs/specification.md
  5. 55
      docs/specification.txt
  6. 34
      src/Buffer.cpp
  7. 3
      src/Buffer.h

69
docs/design.md

@ -0,0 +1,69 @@
# File Browser
## DESIGN DOCUMENT
### COMPONENT: class FileBrowser
A simple file browser. See program specification for details.
#### Public method:
* void run()
Runs the browser.
**Implementation note**: Holds the lines of text in a Buffer object. The displaying of the buffer contents and the execution of the commands is delegated to the Buffer object.
Collaborator: Buffer.
### COMPONENT: class Buffer
A buffer for a simple file browser. Holds the lines of text and executes commands on them. Displays the contents of the buffer. See program specification for details on commands.
#### Public methods:
* Buffer()
(Compiler-generated.) Creates an empty buffer.
* void display() const
Displays the lines of text that the user is currently viewing.
* const string & file_name() const
Returns the name of the file.
* bool go(int link)
Goes to the specified link in the current file. This opens the new link file and adds it to the open history.
* void max_links()
Returns the maximum number of links on the page. This is used by the file browser.
* void move_to_next_page()
Self-explanatory.
* void move_to_previous_page()
Self-explanatory.
* bool open(const string & file_name)
Executes the corresponding file viewer command on the buffer. See program specification for details. The method open returns true if successful.
* void set_maximum_length(int l)
Self-explanatory.
* void set_window_height(int h)
Self-explanatory.
**Implementation note**: Stores each line of text as a string and all the lines in a vector. Also stores the index of the line currently displayed at the top of the window, as well as the name of the file and the window height.

51
docs/design.txt

@ -1,51 +0,0 @@
File Browser
DESIGN DOCUMENT
COMPONENT: class FileBrowser
A simple file browser. See program specification for details.
Public method:
* void run()
Runs the browser.
Implementation note: Holds the lines of text in a Buffer object. The displaying of the buffer contents and the execution of the commands is delegated to the Buffer object.
Collaborator: Buffer.
COMPONENT: class Buffer
A buffer for a simple file browser. Holds the lines of text and executes commands on them. Displays the contents of the buffer. See program specification for details on commands.
Public methods:
* Buffer()
(Compiler-generated.) Creates an empty buffer.
* void display() const
Displays the lines of text that the user is currently viewing.
* const string & file_name() const
Returns the name of the file.
* void move_to_next_page()
void move_to_previous_page()
bool open(const string & file_name)
Executes the corresponding file viewer command on the buffer. See program specification for details. The method open returns true if successful.
* void set_window_height(int h)
Self-explanatory.
Implementation note: Stores each line of text as a string and all the lines in a vector. Also stores the index of the line currently displayed at the top of the window, as well as the name of the file and the window height.

3
docs/sample_interface.txt

@ -13,7 +13,8 @@ preface.txt
11 In fact, the creation of large computer programs poses three basic
12 challenges. The overall goal of these notes is to teach you
--------------------------------------------------
next previous open quit
next previous open
go back quit
-------
command: o
file: introduction.txt

60
docs/specification.md

@ -0,0 +1,60 @@
File browser
# SPECIFICATION
## OVERVIEW
A simple file browser that allows the user view the contents of a text file.
## DETAILS
The program interacts with the user as shown in the following example:
```
preface.txt
--------------------------------------------------
1 These notes are for a second course on computer programming and
2 software development. In a first course, you likely focused on
3 learning the basics: variables, control statements, input and
4 output, files, vectors (or arrays), functions and structures. You
5 may have also had an introduction to classes. These concepts are
6 critically important and they are sufficient for the creation of
7 many useful programs. But many other programs, especially large
8 ones, require more powerful concepts and techniques. And a deeper
9 understanding of classes and design principles.
10
11 In fact, the creation of large computer programs poses three basic
12 challenges. The overall goal of these notes is to teach you
--------------------------------------------------
next previous open quit
-------
command: o
file: introduction.txt
```
The program begins by asking the user for a window height. This is the number of lines that will be displayed as each "page". Then, the user will be asked for the maximum number of characters displayed per line. The displayed lines are numbered starting at 1 for the first line of the file. If the number of lines on the last page is smaller than the window height, the rest of the window is filled with unnumbered empty lines.
Each page is displayed between two lines of 50 dashes. The name of the file is printed above the first line of dashes. If no file is currently open, the string "<no file opened>" is printed instead of the file name.
Below the second line of dashes, a menu of commands is displayed. Below that menu, the prompt "choice:" is displayed. The user types the first letter of a command, the command executes and everything is redisplayed. Some commands prompt the user for more information.
Here is a description of the various commands:
* open: Asks for a file name (with prompt "file:") and displays that file after parsing the proper tags and links. If a file named X does not open, the message "ERROR: Could not open X" is displayed just before the file name is redisplayed.
* next: The next page is displayed. Does nothing if the last line of the file is already displayed.
* previous: The previous page is displayed. Does nothing if the first line of the file is already displayed.
* go: Go to the specified link number on the page. This opens the file to that link and displays it starting from the top line.
* back: Allows you to move back to old files that you navigated to through links. **Note**: This does not apply to when files are opened through the open command.
* quit: Stops the program.
## NOTES FOR LATER VERSIONS
Add more error-checking. For example, check that commands are entered properly and that the window height is a positive integer.

55
docs/specification.txt

@ -1,55 +0,0 @@
File browser
SPECIFICATION
OVERVIEW
A simple file browser that allows the user view the contents of a text file.
DETAILS
The program interacts with the user as shown in the following example:
preface.txt
--------------------------------------------------
1 These notes are for a second course on computer programming and
2 software development. In a first course, you likely focused on
3 learning the basics: variables, control statements, input and
4 output, files, vectors (or arrays), functions and structures. You
5 may have also had an introduction to classes. These concepts are
6 critically important and they are sufficient for the creation of
7 many useful programs. But many other programs, especially large
8 ones, require more powerful concepts and techniques. And a deeper
9 understanding of classes and design principles.
10
11 In fact, the creation of large computer programs poses three basic
12 challenges. The overall goal of these notes is to teach you
--------------------------------------------------
next previous open quit
-------
command: o
file: introduction.txt
The program begins by asking the user for a window height. This is the number of lines that will be displayed as each "page". The displayed lines are numbered starting at 1 for the first line of the file. If the number of lines on the last page is smaller than the window height, the rest of the window is filled with unnumbered empty lines.
Each page is displayed between two lines of 50 dashes. The name of the file is printed above the first line of dashes. If no file is currently open, the string "<no file opened>" is printed instead of the file name.
Below the second line of dashes, a menu of commands is displayed. Below that menu, the prompt "choice:" is displayed. The user types the first letter of a command, the command executes and everything is redisplayed. Some commands prompt the user for more information.
Here is a description of the various commands:
next: The next page is displayed. Does nothing if the last line of the file is already displayed.
previous: The previous page is displayed. Does nothing if the first line of the file is already displayed.
open: Asks for a file name (with prompt "file:") and displays that file. If a file named X does not open, the message "ERROR: Could not open X" is displayed just before the file name is redisplayed.
quit: Stops the program.
NOTES FOR LATER VERSIONS
Add more error-checking. For example, check that commands are entered properly and that the window height is a positive integer.

34
src/Buffer.cpp

@ -58,6 +58,14 @@ vector<string> Buffer::split_line(string & str) {
{
searching = false;
}
//Check
else if (curr_pos > maximum_length_)
{
searching = false;
total_pos = maximum_length_;
str = str.substr(0, total_pos - 1) + "- " + str.substr(total_pos - 1, str.length());
cout << str << endl;
}
else if (total_pos + curr_pos + 1 > maximum_length_)
{
searching = false;
@ -112,7 +120,7 @@ bool Buffer::open(const string & new_file_name)
auto tag_len = line.find_first_of('>', tag_loc) - tag_loc;
std::string link_tag = line.substr(tag_loc + 3, tag_len - 3);
// separate the link path and link name into separate strings. Assuming no spaces in the link path.
// Separate the link path and link name into separate strings. Assuming no spaces in the link path.
auto second_space_loc = link_tag.find_first_of(' ', 0);
std::string file_name = link_tag.substr(0, second_space_loc - 1);
std::string link_name = link_tag.substr(second_space_loc + 1);
@ -141,6 +149,7 @@ bool Buffer::open(const string & new_file_name)
// However, if the tag is located at the start of the file, there will be no data, so it shouldn't be added as it will be an empty line.
if(curr_line != "")
{
//TODO This is causing some issues
v_lines_.push_back(curr_line);
curr_line = "";
@ -157,7 +166,6 @@ bool Buffer::open(const string & new_file_name)
if (curr_line.length() > maximum_length_) {
vector<string> v_split_line = split_line(curr_line);
for (auto e: v_split_line) {
cout << e << endl;
v_lines_.push_back(e);
}
}
@ -172,18 +180,18 @@ bool Buffer::open(const string & new_file_name)
return true;
}
bool Buffer::go(int link)
{
string f_name = v_links_[link - 1].second;
bool Buffer::go(int link)
{
string f_name = v_links_[link - 1].second;
if(!open(f_name))
return false;
else
return true;
if(!open(f_name))
return false;
else
return true;
}
}
void Buffer::back()
{
void Buffer::back()
{
}
}

3
src/Buffer.h

@ -17,14 +17,13 @@ public:
void display() const;
const std::string & file_name() const { return file_name_; }
bool go(int link);
int max_links();
void move_to_next_page();
void move_to_previous_page();
int max_links();
bool open(const std::string & file_name);
//std::string* get_lines() const;
void set_maximum_length(int l) { maximum_length_ = l; }
void set_window_height(int h) { window_height_ = h; }
//Made window height public so the display function can be removed
private:
std::size_t get_tag_(const std::string & line);

Loading…
Cancel
Save