/* This Source Code Form is subject to the terms of the Mozilla Public * License, v. 2.0. If a copy of the MPL was not distributed with this * file, You can obtain one at http://mozilla.org/MPL/2.0/. */ // Package todotxt is a Go client library for Gina Trapani's todo.txt files. // It allows for parsing and manipulating of task lists and tasks in the todo.txt format. // // Source code and project home: https://github.com/JamesClonk/go-todotxt package todotxt import ( "bufio" "errors" "fmt" "io/ioutil" "os" "strings" ) // TaskList represents a list of todo.txt task entries. // It is usually loaded from a whole todo.txt file. type TaskList []Task // IgnoreComments can be set to 'true', to ignore lines that start with # // The todo.txt format does not define comments. var ( // IgnoreComments is used to switch ignoring of comments (lines starting with "#"). // If this is set to 'false', then lines starting with "#" will be parsed as tasks. IgnoreComments = false ) // NewTaskList creates a new empty TaskList. func NewTaskList() *TaskList { return &TaskList{} } // String returns a complete list of tasks in todo.txt format. func (tasklist TaskList) String() (text string) { for _, task := range tasklist { text += fmt.Sprintf("%s\n", task.String()) } return text } // AddTask appends a Task to the current TaskList and takes care to set the Task.Id correctly, modifying the Task by the given pointer! func (tasklist *TaskList) AddTask(task *Task) { task.Id = 0 for _, t := range *tasklist { if t.Id > task.Id { task.Id = t.Id } } task.Id += 1 *tasklist = append(*tasklist, *task) } // GetTask returns a Task by given task 'id' from the TaskList. The returned Task pointer can be used to update the Task inside the TaskList. // Returns an error if Task could not be found. func (tasklist *TaskList) GetTask(id int) (*Task, error) { for i := range *tasklist { if ([]Task(*tasklist))[i].Id == id { return &([]Task(*tasklist))[i], nil } } return nil, errors.New("task not found") } // RemoveTaskById removes any Task with given Task 'id' from the TaskList. // Returns an error if no Task was removed. func (tasklist *TaskList) RemoveTaskById(id int) error { var newList TaskList found := false for _, t := range *tasklist { if t.Id != id { newList = append(newList, t) } else { found = true } } if !found { return errors.New("task not found") } *tasklist = newList return nil } // RemoveTask removes any Task from the TaskList with the same String representation as the given Task. // Returns an error if no Task was removed. func (tasklist *TaskList) RemoveTask(task Task) error { var newList TaskList found := false for _, t := range *tasklist { if t.String() != task.String() { newList = append(newList, t) } else { found = true } } if !found { return errors.New("task not found") } *tasklist = newList return nil } // ArchiveTaskToFile removes the task from the active list and concatenates it to // the passed in filename // Return an err if any part of that fails func (tasklist *TaskList) ArchiveTaskToFile(task Task, filename string) error { if err := tasklist.RemoveTask(task); err != nil { return err } f, err := os.OpenFile(filename, os.O_APPEND|os.O_WRONLY, 0600) if err != nil { return err } defer f.Close() _, err = f.WriteString(task.String() + "\n") return err } // Filter filters the current TaskList for the given predicate (a function that takes a task as input and returns a bool), // and returns a new TaskList. The original TaskList is not modified. func (tasklist *TaskList) Filter(predicate func(Task) bool) *TaskList { var newList TaskList for _, t := range *tasklist { if predicate(t) { newList = append(newList, t) } } return &newList } // LoadFromFile loads a TaskList from *os.File. // // Using *os.File instead of a filename allows to also use os.Stdin. // // Note: This will clear the current TaskList and overwrite it's contents with whatever is in *os.File. func (tasklist *TaskList) LoadFromFile(file *os.File) error { *tasklist = []Task{} // Empty tasklist taskId := 1 scanner := bufio.NewScanner(file) for scanner.Scan() { text := strings.Trim(scanner.Text(), "\t\n\r ") // Read line // Ignore blank or comment lines if text == "" || (IgnoreComments && strings.HasPrefix(text, "#")) { continue } task, err := ParseTask(text) if err != nil { return err } task.Id = taskId *tasklist = append(*tasklist, *task) taskId++ } if err := scanner.Err(); err != nil { return err } return nil } // WriteToFile writes a TaskList to *os.File. // // Using *os.File instead of a filename allows to also use os.Stdout. func (tasklist *TaskList) WriteToFile(file *os.File) error { writer := bufio.NewWriter(file) _, err := writer.WriteString(tasklist.String()) writer.Flush() return err } // LoadFromFilename loads a TaskList from a file (most likely called "todo.txt"). // // Note: This will clear the current TaskList and overwrite it's contents with whatever is in the file. func (tasklist *TaskList) LoadFromFilename(filename string) error { file, err := os.Open(filename) if err != nil { return err } defer file.Close() return tasklist.LoadFromFile(file) } // WriteToFilename writes a TaskList to the specified file (most likely called "todo.txt"). func (tasklist *TaskList) WriteToFilename(filename string) error { return ioutil.WriteFile(filename, []byte(tasklist.String()), 0640) } // LoadFromFile loads and returns a TaskList from *os.File. // // Using *os.File instead of a filename allows to also use os.Stdin. func LoadFromFile(file *os.File) (TaskList, error) { tasklist := TaskList{} if err := tasklist.LoadFromFile(file); err != nil { return nil, err } return tasklist, nil } // WriteToFile writes a TaskList to *os.File. // // Using *os.File instead of a filename allows to also use os.Stdout. func WriteToFile(tasklist *TaskList, file *os.File) error { return tasklist.WriteToFile(file) } // LoadFromFilename loads and returns a TaskList from a file (most likely called "todo.txt"). func LoadFromFilename(filename string) (TaskList, error) { tasklist := TaskList{} if err := tasklist.LoadFromFilename(filename); err != nil { return nil, err } return tasklist, nil } // WriteToFilename writes a TaskList to the specified file (most likely called "todo.txt"). func WriteToFilename(tasklist *TaskList, filename string) error { return tasklist.WriteToFilename(filename) }