// Copyright (c) 2014-2018 Thomas Fussell // Copyright (c) 2010-2015 openpyxl // // 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, WRISING FROM, // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN // THE SOFTWARE // // @license: http://www.opensource.org/licenses/mit-license.php // @author: see AUTHORS file #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include namespace { int points_to_pixels(double points, double dpi) { return static_cast(std::ceil(points * dpi / 72)); } } // namespace namespace xlnt { worksheet::worksheet() : d_(nullptr) { } worksheet::worksheet(detail::worksheet_impl *d) : d_(d) { } worksheet::worksheet(const worksheet &rhs) : d_(rhs.d_) { } bool worksheet::has_frozen_panes() const { return !d_->views_.empty() && d_->views_.front().has_pane() && (d_->views_.front().pane().state == pane_state::frozen || d_->views_.front().pane().state == pane_state::frozen_split); } void worksheet::create_named_range(const std::string &name, const std::string &reference_string) { create_named_range(name, range_reference(reference_string)); } void worksheet::create_named_range(const std::string &name, const range_reference &reference) { try { auto temp = cell_reference::split_reference(name); // name is a valid reference, make sure it's outside the allowed range if (column_t(temp.first).index <= column_t("XFD").index && temp.second <= 1048576) { throw invalid_parameter(); //("named range name must be outside the range A1-XFD1048576"); } } catch (xlnt::invalid_cell_reference &) { // name is not a valid reference, that's good } std::vector targets; targets.push_back({*this, reference}); d_->named_ranges_[name] = xlnt::named_range(name, targets); } cell worksheet::operator[](const cell_reference &ref) { return cell(ref); } std::vector worksheet::merged_ranges() const { return d_->merged_cells_; } bool worksheet::has_page_margins() const { return d_->page_margins_.is_set(); } bool worksheet::has_page_setup() const { return d_->page_setup_.is_set(); } page_margins worksheet::page_margins() const { return d_->page_margins_.get(); } void worksheet::page_margins(const class page_margins &margins) { d_->page_margins_ = margins; } void worksheet::auto_filter(const std::string &reference_string) { auto_filter(range_reference(reference_string)); } void worksheet::auto_filter(const range_reference &reference) { d_->auto_filter_ = reference; } void worksheet::auto_filter(const xlnt::range &range) { auto_filter(range.reference()); } range_reference worksheet::auto_filter() const { return d_->auto_filter_.get(); } bool worksheet::has_auto_filter() const { return d_->auto_filter_.is_set(); } void worksheet::clear_auto_filter() { d_->auto_filter_.clear(); } void worksheet::page_setup(const struct page_setup &setup) { d_->page_setup_ = setup; } page_setup worksheet::page_setup() const { if (!has_page_setup()) { throw invalid_attribute(); } return d_->page_setup_.get(); } workbook &worksheet::workbook() { return *d_->parent_; } const workbook &worksheet::workbook() const { return *d_->parent_; } void worksheet::garbage_collect() { auto cell_iter = d_->cell_map_.begin(); while (cell_iter != d_->cell_map_.end()) { if (xlnt::cell(&cell_iter->second).garbage_collectible()) { cell_iter = d_->cell_map_.erase(cell_iter); } else { ++cell_iter; } } } void worksheet::id(std::size_t id) { d_->id_ = id; } std::size_t worksheet::id() const { return d_->id_; } std::string worksheet::title() const { return d_->title_; } void worksheet::title(const std::string &title) { // do no work if we don't need to if (d_->title_ == title) { return; } // excel limits worksheet titles to 31 characters if (title.empty() || title.length() > 31) { throw invalid_sheet_title(title); } // invalid characters in a worksheet name if (title.find_first_of("*:/\\?[]") != std::string::npos) { throw invalid_sheet_title(title); } // try and insert the new name into the worksheets map // if the insert fails, we have a duplicate sheet name auto insert_result = workbook().d_->sheet_title_rel_id_map_.insert( std::make_pair(title, workbook().d_->sheet_title_rel_id_map_[d_->title_])); if (!insert_result.second) // insert failed, duplication detected { throw invalid_sheet_title(title); } // if the insert succeeded (i.e. wasn't a duplicate sheet name) // update the worksheet title and remove the old relation workbook().d_->sheet_title_rel_id_map_.erase(d_->title_); d_->title_ = title; workbook().update_sheet_properties(); } cell_reference worksheet::frozen_panes() const { if (!has_frozen_panes()) { throw xlnt::invalid_attribute(); } return d_->views_.front().pane().top_left_cell.get(); } void worksheet::freeze_panes(xlnt::cell top_left_cell) { freeze_panes(top_left_cell.reference()); } void worksheet::freeze_panes(const cell_reference &ref) { if (ref == "A1") { unfreeze_panes(); return; } if (!has_view()) { d_->views_.push_back(sheet_view()); } auto &primary_view = d_->views_.front(); if (!primary_view.has_pane()) { primary_view.pane(pane()); } primary_view.pane().top_left_cell = ref; primary_view.pane().state = pane_state::frozen; primary_view.clear_selections(); if (ref.column() == "A") // no column is frozen { primary_view.add_selection(selection(pane_corner::bottom_left, ref)); primary_view.pane().active_pane = pane_corner::bottom_left; primary_view.pane().y_split = ref.row() - 1; } else if (ref.row() == 1) // no row is frozen { primary_view.add_selection(selection(pane_corner::top_right, ref)); primary_view.pane().active_pane = pane_corner::top_right; primary_view.pane().x_split = ref.column_index() - 1; } else // column and row is frozen { primary_view.add_selection(selection(pane_corner::top_right, cell_reference(ref.column(), 1))); primary_view.add_selection(selection(pane_corner::bottom_left, cell_reference(1, ref.row()))); primary_view.add_selection(selection(pane_corner::bottom_right, ref)); primary_view.pane().active_pane = pane_corner::bottom_right; primary_view.pane().x_split = ref.column_index() - 1; primary_view.pane().y_split = ref.row() - 1; } } void worksheet::unfreeze_panes() { if (!has_view()) return; auto &primary_view = d_->views_.front(); primary_view.clear_selections(); primary_view.clear_pane(); } void worksheet::active_cell(const cell_reference &ref) { if (!has_view()) { d_->views_.push_back(sheet_view()); } auto &primary_view = d_->views_.front(); if (!primary_view.has_selections()) { primary_view.add_selection(selection(pane_corner::bottom_right, ref)); } else { primary_view.selection(0).active_cell(ref); } } bool worksheet::has_active_cell() const { if (!has_view()) return false; auto &primary_view = d_->views_.front(); if (!primary_view.has_selections()) return false; auto primary_selection = primary_view.selection(0); return primary_selection.has_active_cell(); } cell_reference worksheet::active_cell() const { if (!has_view()) { throw xlnt::exception("Worksheet has no view."); } auto &primary_view = d_->views_.front(); if (!primary_view.has_selections()) { throw xlnt::exception("Default worksheet view has no selections."); } return primary_view.selection(0).active_cell(); } cell worksheet::cell(const cell_reference &reference) { auto match = d_->cell_map_.find(reference); if (match == d_->cell_map_.end()) { auto impl = detail::cell_impl(); impl.parent_ = d_; impl.column_ = reference.column_index(); impl.row_ = reference.row(); match = d_->cell_map_.emplace(reference, impl).first; } return xlnt::cell(&match->second); } const cell worksheet::cell(const cell_reference &reference) const { return xlnt::cell(&d_->cell_map_.at(reference)); } cell worksheet::cell(xlnt::column_t column, row_t row) { return cell(cell_reference(column, row)); } const cell worksheet::cell(xlnt::column_t column, row_t row) const { return cell(cell_reference(column, row)); } bool worksheet::has_cell(const cell_reference &reference) const { const auto cell = d_->cell_map_.find(reference); return cell != d_->cell_map_.cend(); } bool worksheet::has_row_properties(row_t row) const { return d_->row_properties_.find(row) != d_->row_properties_.end(); } range worksheet::named_range(const std::string &name) { if (!workbook().has_named_range(name)) { throw key_not_found(); } if (!has_named_range(name)) { throw key_not_found(); } return range(d_->named_ranges_[name].targets()[0].second); } const range worksheet::named_range(const std::string &name) const { if (!workbook().has_named_range(name)) { throw key_not_found(); } if (!has_named_range(name)) { throw key_not_found(); } return range(d_->named_ranges_[name].targets()[0].second); } column_t worksheet::lowest_column() const { if (d_->cell_map_.empty()) { return constants::min_column(); } auto lowest = constants::max_column(); for (auto &cell : d_->cell_map_) { lowest = std::min(lowest, cell.first.column()); } return lowest; } column_t worksheet::lowest_column_or_props() const { auto lowest = lowest_column(); if (d_->cell_map_.empty() && !d_->column_properties_.empty()) { lowest = d_->column_properties_.begin()->first; } for (auto &props : d_->column_properties_) { lowest = std::min(lowest, props.first); } return lowest; } row_t worksheet::lowest_row() const { if (d_->cell_map_.empty()) { return constants::min_row(); } auto lowest = constants::max_row(); for (auto &cell : d_->cell_map_) { lowest = std::min(lowest, cell.first.row()); } return lowest; } row_t worksheet::lowest_row_or_props() const { auto lowest = lowest_row(); if (d_->cell_map_.empty() && !d_->row_properties_.empty()) { lowest = d_->row_properties_.begin()->first; } for (auto &props : d_->row_properties_) { lowest = std::min(lowest, props.first); } return lowest; } row_t worksheet::highest_row() const { auto highest = constants::min_row(); for (auto &cell : d_->cell_map_) { highest = std::max(highest, cell.first.row()); } return highest; } row_t worksheet::highest_row_or_props() const { auto highest = highest_row(); if (d_->cell_map_.empty() && !d_->row_properties_.empty()) { highest = d_->row_properties_.begin()->first; } for (auto &props : d_->row_properties_) { highest = std::max(highest, props.first); } return highest; } column_t worksheet::highest_column() const { auto highest = constants::min_column(); for (auto &cell : d_->cell_map_) { highest = std::max(highest, cell.first.column()); } return highest; } column_t worksheet::highest_column_or_props() const { auto highest = highest_column(); if (d_->cell_map_.empty() && !d_->column_properties_.empty()) { highest = d_->column_properties_.begin()->first; } for (auto &props : d_->column_properties_) { highest = std::max(highest, props.first); } return highest; } range_reference worksheet::calculate_dimension() const { return range_reference(lowest_column(), lowest_row(), highest_column(), highest_row_or_props()); } range worksheet::range(const std::string &reference_string) { if (has_named_range(reference_string)) { return named_range(reference_string); } return range(range_reference(reference_string)); } const range worksheet::range(const std::string &reference_string) const { if (has_named_range(reference_string)) { return named_range(reference_string); } return range(range_reference(reference_string)); } range worksheet::range(const range_reference &reference) { return xlnt::range(*this, reference); } const range worksheet::range(const range_reference &reference) const { return xlnt::range(*this, reference); } void worksheet::merge_cells(const std::string &reference_string) { merge_cells(range_reference(reference_string)); } void worksheet::unmerge_cells(const std::string &reference_string) { unmerge_cells(range_reference(reference_string)); } void worksheet::merge_cells(const range_reference &reference) { d_->merged_cells_.push_back(reference); bool first = true; for (auto row : range(reference)) { for (auto cell : row) { cell.merged(true); if (!first) { if (cell.data_type() == cell::type::shared_string) { cell.value(""); } else { cell.clear_value(); } } first = false; } } } void worksheet::unmerge_cells(const range_reference &reference) { auto match = std::find(d_->merged_cells_.begin(), d_->merged_cells_.end(), reference); if (match == d_->merged_cells_.end()) { throw invalid_parameter(); } d_->merged_cells_.erase(match); for (auto row : range(reference)) { for (auto cell : row) { cell.merged(false); } } } row_t worksheet::next_row() const { auto row = highest_row() + 1; if (row == 2 && d_->cell_map_.size() == 0) { row = 1; } return row; } xlnt::range worksheet::rows(bool skip_null) { return xlnt::range(*this, calculate_dimension(), major_order::row, skip_null); } const xlnt::range worksheet::rows(bool skip_null) const { return xlnt::range(*this, calculate_dimension(), major_order::row, skip_null); } xlnt::range worksheet::columns(bool skip_null) { return xlnt::range(*this, calculate_dimension(), major_order::column, skip_null); } const xlnt::range worksheet::columns(bool skip_null) const { return xlnt::range(*this, calculate_dimension(), major_order::column, skip_null); } /* //TODO: finish implementing cell_iterator wrapping before uncommenting cell_vector worksheet::cells(bool skip_null) { const auto dimension = calculate_dimension(); return cell_vector(*this, dimension.top_left(), dimension, major_order::row, skip_null, true); } const cell_vector worksheet::cells(bool skip_null) const { const auto dimension = calculate_dimension(); return cell_vector(*this, dimension.top_left(), dimension, major_order::row, skip_null, true); } */ void worksheet::clear_cell(const cell_reference &ref) { d_->cell_map_.erase(ref); // TODO: garbage collect newly unreferenced resources such as styles? } void worksheet::clear_row(row_t row) { for (auto it = d_->cell_map_.begin(); it != d_->cell_map_.end();) { if (it->first.row() == row) { it = d_->cell_map_.erase(it); } else { ++it; } } d_->row_properties_.erase(row); // TODO: garbage collect newly unreferenced resources such as styles? } bool worksheet::operator==(const worksheet &other) const { return compare(other, true); } bool worksheet::compare(const worksheet &other, bool reference) const { if (reference) { return d_ == other.d_; } if (d_->parent_ != other.d_->parent_) return false; for (auto &cell : d_->cell_map_) { if (other.d_->cell_map_.find(cell.first) == other.d_->cell_map_.end()) { return false; } xlnt::cell this_cell(&cell.second); xlnt::cell other_cell(&other.d_->cell_map_[cell.first]); if (this_cell.data_type() != other_cell.data_type()) { return false; } if (this_cell.data_type() == xlnt::cell::type::number && !detail::float_equals(this_cell.value(), other_cell.value())) { return false; } } // todo: missing some comparisons if (d_->auto_filter_ == other.d_->auto_filter_ && d_->views_ == other.d_->views_ && d_->merged_cells_ == other.d_->merged_cells_) { return true; } return false; } bool worksheet::operator!=(const worksheet &other) const { return !(*this == other); } bool worksheet::operator==(std::nullptr_t) const { return d_ == nullptr; } bool worksheet::operator!=(std::nullptr_t) const { return d_ != nullptr; } void worksheet::operator=(const worksheet &other) { d_ = other.d_; } const cell worksheet::operator[](const cell_reference &ref) const { return cell(ref); } bool worksheet::has_named_range(const std::string &name) const { return d_->named_ranges_.find(name) != d_->named_ranges_.end(); } void worksheet::remove_named_range(const std::string &name) { if (!has_named_range(name)) { throw key_not_found(); } d_->named_ranges_.erase(name); } void worksheet::reserve(std::size_t n) { d_->cell_map_.reserve(n); } class header_footer worksheet::header_footer() const { return d_->header_footer_.get(); } cell_reference worksheet::point_pos(int left, int top) const { column_t current_column = 1; row_t current_row = 1; double left_pos = 0; double top_pos = 0; while (left_pos <= left) { left_pos += column_width(current_column++); } while (top_pos <= top) { top_pos += row_height(current_row++); } return {current_column - 1, current_row - 1}; } void worksheet::sheet_state(xlnt::sheet_state state) { page_setup().sheet_state(state); } sheet_state worksheet::sheet_state() const { return page_setup().sheet_state(); } void worksheet::add_column_properties(column_t column, const xlnt::column_properties &props) { d_->column_properties_[column] = props; } bool worksheet::has_column_properties(column_t column) const { return d_->column_properties_.find(column) != d_->column_properties_.end(); } column_properties &worksheet::column_properties(column_t column) { return d_->column_properties_[column]; } const column_properties &worksheet::column_properties(column_t column) const { return d_->column_properties_.at(column); } row_properties &worksheet::row_properties(row_t row) { return d_->row_properties_[row]; } const row_properties &worksheet::row_properties(row_t row) const { return d_->row_properties_.at(row); } void worksheet::add_row_properties(row_t row, const xlnt::row_properties &props) { d_->row_properties_[row] = props; } worksheet::iterator worksheet::begin() { return rows().begin(); } worksheet::iterator worksheet::end() { return rows().end(); } worksheet::const_iterator worksheet::cbegin() const { return rows().cbegin(); } worksheet::const_iterator worksheet::cend() const { return rows().cend(); } worksheet::const_iterator worksheet::begin() const { return cbegin(); } worksheet::const_iterator worksheet::end() const { return cend(); } void worksheet::print_title_rows(row_t last_row) { print_title_rows(1, last_row); } void worksheet::print_title_rows(row_t first_row, row_t last_row) { d_->print_title_rows_ = std::to_string(first_row) + ":" + std::to_string(last_row); } void worksheet::print_title_cols(column_t last_column) { print_title_cols(1, last_column); } void worksheet::print_title_cols(column_t first_column, column_t last_column) { d_->print_title_cols_ = first_column.column_string() + ":" + last_column.column_string(); } std::string worksheet::print_titles() const { if (!d_->print_title_rows_.empty() && !d_->print_title_cols_.empty()) { return d_->title_ + "!" + d_->print_title_rows_ + "," + d_->title_ + "!" + d_->print_title_cols_; } else if (!d_->print_title_cols_.empty()) { return d_->title_ + "!" + d_->print_title_cols_; } else { return d_->title_ + "!" + d_->print_title_rows_; } } void worksheet::print_area(const std::string &print_area) { d_->print_area_ = range_reference::make_absolute(range_reference(print_area)); } range_reference worksheet::print_area() const { return d_->print_area_.get(); } bool worksheet::has_view() const { return !d_->views_.empty(); } sheet_view &worksheet::view(std::size_t index) const { return d_->views_.at(index); } void worksheet::add_view(const sheet_view &new_view) { d_->views_.push_back(new_view); } void worksheet::register_comments_in_manifest() { workbook().register_worksheet_part(*this, relationship_type::comments); } void worksheet::register_calc_chain_in_manifest() { workbook().register_workbook_part(relationship_type::calculation_chain); } bool worksheet::has_phonetic_properties() const { return d_->phonetic_properties_.is_set(); } const phonetic_pr &worksheet::phonetic_properties() const { return d_->phonetic_properties_.get(); } void worksheet::phonetic_properties(const phonetic_pr &phonetic_props) { d_->phonetic_properties_.set(phonetic_props); } bool worksheet::has_header_footer() const { return d_->header_footer_.is_set(); } void worksheet::header_footer(const class header_footer &hf) { d_->header_footer_ = hf; } void worksheet::clear_page_breaks() { d_->row_breaks_.clear(); d_->column_breaks_.clear(); } void worksheet::page_break_at_row(row_t row) { d_->row_breaks_.push_back(row); } const std::vector &worksheet::page_break_rows() const { return d_->row_breaks_; } void worksheet::page_break_at_column(xlnt::column_t column) { d_->column_breaks_.push_back(column); } const std::vector &worksheet::page_break_columns() const { return d_->column_breaks_; } double worksheet::column_width(column_t column) const { static const auto DefaultColumnWidth = 51.85; if (has_column_properties(column)) { return column_properties(column).width.get(); } else { return points_to_pixels(DefaultColumnWidth, 96.0); } } double worksheet::row_height(row_t row) const { static const auto DefaultRowHeight = 15.0; if (has_row_properties(row) && row_properties(row).height.is_set()) { return row_properties(row).height.get(); } else { return points_to_pixels(DefaultRowHeight, 96.0); } } void worksheet::garbage_collect_formulae() { workbook().garbage_collect_formulae(); } void worksheet::parent(xlnt::workbook &wb) { d_->parent_ = &wb; } conditional_format worksheet::conditional_format(const range_reference &ref, const condition &when) { return workbook().d_->stylesheet_.get().add_conditional_format_rule(d_, ref, when); } path worksheet::path() const { auto rel = referring_relationship(); return xlnt::path(rel.source().path().parent().append(rel.target().path())); } relationship worksheet::referring_relationship() const { auto &manifest = workbook().manifest(); auto wb_rel = manifest.relationship(xlnt::path("/"), relationship_type::office_document); auto ws_rel = manifest.relationship(wb_rel.target().path(), workbook().d_->sheet_title_rel_id_map_.at(title())); return ws_rel; } sheet_format_properties worksheet::format_properties() const { return d_->format_properties_; } void worksheet::format_properties(const sheet_format_properties &properties) { d_->format_properties_ = properties; } } // namespace xlnt