From 51734065a38cf6db48fe9fb4b16461ce424cad90 Mon Sep 17 00:00:00 2001
From: Your Name <you@example.com>
Date: Sat, 21 Nov 2020 14:33:33 -0500
Subject: Updated API to be more explicit with references

---
 libbible.h | 20 +++++++++++++-------
 1 file changed, 13 insertions(+), 7 deletions(-)

(limited to 'libbible.h')

diff --git a/libbible.h b/libbible.h
index 85ea9eb..c1058e7 100644
--- a/libbible.h
+++ b/libbible.h
@@ -3,7 +3,7 @@
 #include <map>
 
 namespace libbible {
-    
+
     struct text {
         int chapter;
         int verse;
@@ -17,7 +17,6 @@ namespace libbible {
         std::string modName;
         std::string book;
         std::string bookShort;
-        std::string reference;
         int chapterStart;
         int verseStart;
         int chapterEnd;
@@ -34,14 +33,21 @@ namespace libbible {
      */
     std::vector<struct passage> getPassages(std::string modName, std::string book);
 
+    /*
+     * @param modName the module to use for determining the passage
+     * @param reference a human-readable reference, e.g., "gen 1:26-27"
+     * @return the passage matching the reference
+     */
+    passage getPassage(std::string modName, std::string reference);
+
     /*
      * @return Text for a passage
      */
     std::vector<struct text> getText(struct passage pass);
 
     /**************************
-    * Methods dealing with mods
-    ***************************/
+     * Methods dealing with mods
+     ***************************/
 
     class Status {
         public:
@@ -82,9 +88,9 @@ namespace libbible {
     void uninstallMod(std::string modname);
 
     /******************************
-    * Methods dealing with settings
-    *******************************/
-    
+     * Methods dealing with settings
+     *******************************/
+
     /*
      * From already established code, valid and useful values are:
      *    int fontsize: the last used size of the font
-- 
cgit v1.2.3