taskwarrior/src/sort.cpp

257 lines
9.5 KiB
C++

////////////////////////////////////////////////////////////////////////////////
//
// Copyright 2006 - 2021, Tomas Babej, Paul Beckingham, Federico Hernandez.
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included
// in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
// THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.
//
// https://www.opensource.org/licenses/mit-license.php
//
////////////////////////////////////////////////////////////////////////////////
#include <cmake.h>
// cmake.h include header must come first
#include <Context.h>
#include <Duration.h>
#include <Task.h>
#include <format.h>
#include <shared.h>
#include <stdlib.h>
#include <util.h>
#include <algorithm>
#include <list>
#include <map>
#include <string>
#include <vector>
static std::vector<Task>* global_data = nullptr;
static std::vector<std::string> global_keys;
static bool sort_compare(int, int);
////////////////////////////////////////////////////////////////////////////////
void sort_tasks(std::vector<Task>& data, std::vector<int>& order, const std::string& keys) {
Timer timer;
global_data = &data;
// Split the key defs.
global_keys = split(keys, ',');
// Only sort if necessary.
if (order.size()) std::stable_sort(order.begin(), order.end(), sort_compare);
Context::getContext().time_sort_us += timer.total_us();
}
void sort_projects(std::list<std::pair<std::string, int>>& sorted,
std::map<std::string, int>& allProjects) {
for (auto& project : allProjects) {
const std::vector<std::string> parents = extractParents(project.first);
if (parents.size()) {
// if parents exist: store iterator position of last parent
std::list<std::pair<std::string, int>>::iterator parent_pos;
for (auto& parent : parents) {
parent_pos = std::find_if(
sorted.begin(), sorted.end(),
[&parent](const std::pair<std::string, int>& item) { return item.first == parent; });
// if parent does not exist yet: insert into sorted view
if (parent_pos == sorted.end()) sorted.emplace_back(parent, 1);
}
// insert new element below latest parent
sorted.insert((parent_pos == sorted.end()) ? parent_pos : ++parent_pos, project);
} else {
// if has no parents: simply push to end of list
sorted.push_back(project);
}
}
}
void sort_projects(std::list<std::pair<std::string, int>>& sorted,
std::map<std::string, bool>& allProjects) {
std::map<std::string, int> allProjectsInt;
for (auto& p : allProjects) allProjectsInt[p.first] = (int)p.second;
sort_projects(sorted, allProjectsInt);
}
////////////////////////////////////////////////////////////////////////////////
// Re-implementation, using direct Task access instead of data copies that
// require re-parsing.
//
// Essentially a static implementation of a dynamic operator<.
static bool sort_compare(int left, int right) {
std::string field;
bool ascending;
bool breakIndicator;
Column* column;
int left_number;
int right_number;
float left_real;
float right_real;
for (auto& k : global_keys) {
Context::getContext().decomposeSortField(k, field, ascending, breakIndicator);
// Urgency.
if (field == "urgency") {
left_real = (*global_data)[left].urgency();
right_real = (*global_data)[right].urgency();
if (left_real == right_real) continue;
return ascending ? (left_real < right_real) : (left_real > right_real);
}
// Number.
else if (field == "id") {
left_number = (*global_data)[left].id;
right_number = (*global_data)[right].id;
if (left_number == right_number) continue;
return ascending ? (left_number < right_number) : (left_number > right_number);
}
// String.
else if (field == "description" || field == "project" || field == "status" || field == "tags" ||
field == "uuid" || field == "parent" || field == "imask" || field == "mask") {
auto left_string = (*global_data)[left].get_ref(field);
auto right_string = (*global_data)[right].get_ref(field);
if (left_string == right_string) continue;
return ascending ? (left_string < right_string) : (left_string > right_string);
}
// Due Date.
else if (field == "due" || field == "end" || field == "entry" || field == "start" ||
field == "until" || field == "wait" || field == "modified" || field == "scheduled") {
auto left_string = (*global_data)[left].get_ref(field);
auto right_string = (*global_data)[right].get_ref(field);
if (left_string != "" && right_string == "") return true;
if (left_string == "" && right_string != "") return false;
if (left_string == right_string) continue;
return ascending ? (left_string < right_string) : (left_string > right_string);
}
// Depends string.
else if (field == "depends") {
// Raw data is an un-sorted list of UUIDs. We just need a stable
// sort, so we sort them lexically.
auto left_deps = (*global_data)[left].getDependencyUUIDs();
std::sort(left_deps.begin(), left_deps.end());
auto right_deps = (*global_data)[right].getDependencyUUIDs();
std::sort(right_deps.begin(), right_deps.end());
if (left_deps == right_deps) continue;
if (left_deps.size() == 0 && right_deps.size() > 0) return ascending;
if (left_deps.size() > 0 && right_deps.size() == 0) return !ascending;
// Sort on the first dependency.
left_number = Context::getContext().tdb2.id(left_deps[0]);
right_number = Context::getContext().tdb2.id(right_deps[0]);
if (left_number == right_number) continue;
return ascending ? (left_number < right_number) : (left_number > right_number);
}
// Duration.
else if (field == "recur") {
auto left_string = (*global_data)[left].get_ref(field);
auto right_string = (*global_data)[right].get_ref(field);
if (left_string == right_string) continue;
Duration left_duration(left_string);
Duration right_duration(right_string);
return ascending ? (left_duration < right_duration) : (left_duration > right_duration);
}
// UDAs.
else if ((column = Context::getContext().columns[field]) != nullptr) {
std::string type = column->type();
if (type == "numeric") {
auto left_real = strtof(((*global_data)[left].get_ref(field)).c_str(), nullptr);
auto right_real = strtof(((*global_data)[right].get_ref(field)).c_str(), nullptr);
if (left_real == right_real) continue;
return ascending ? (left_real < right_real) : (left_real > right_real);
} else if (type == "string") {
auto left_string = (*global_data)[left].get_ref(field);
auto right_string = (*global_data)[right].get_ref(field);
if (left_string == right_string) continue;
// UDAs of the type string can have custom sort orders, which need to be considered.
auto order = Task::customOrder.find(field);
if (order != Task::customOrder.end()) {
// Guaranteed to be found, because of ColUDA::validate ().
auto posLeft = std::find(order->second.begin(), order->second.end(), left_string);
auto posRight = std::find(order->second.begin(), order->second.end(), right_string);
return ascending ? (posLeft < posRight) : (posLeft > posRight);
} else {
// Empty values are unconditionally last, if no custom order was specified.
if (left_string == "")
return false;
else if (right_string == "")
return true;
return ascending ? (left_string < right_string) : (left_string > right_string);
}
}
else if (type == "date") {
auto left_string = (*global_data)[left].get_ref(field);
auto right_string = (*global_data)[right].get_ref(field);
if (left_string != "" && right_string == "") return true;
if (left_string == "" && right_string != "") return false;
if (left_string == right_string) continue;
return ascending ? (left_string < right_string) : (left_string > right_string);
} else if (type == "duration") {
auto left_string = (*global_data)[left].get_ref(field);
auto right_string = (*global_data)[right].get_ref(field);
if (left_string == right_string) continue;
Duration left_duration(left_string);
Duration right_duration(right_string);
return ascending ? (left_duration < right_duration) : (left_duration > right_duration);
}
} else
throw format("The '{1}' column is not a valid sort field.", field);
}
return false;
}
////////////////////////////////////////////////////////////////////////////////