AutoHotkey Community

AHKList(listname, command="add", subcommand1="", subcommand2="", Debug="1") {
    static
    returnit := 1
    if (command = "add") {
        %listname%0 ++
        Curcount := %Listname%0
        %listname%%Curcount% := Subcommand1
        returnit := curcount
    }

    else if (command = "InsertBefore") {
        if (subcommand2 = "") {
            if (Debug)
                Msgbox Error with command: %Command%`nSubcommand2 is Blank
            returnit := 0
        }
        if (returnit) { ;preform only if no error has occured thusfar
            Curcount := %Listname%0
            if (Subcommand2 > Curcount) {
                if (Debug)
                      Msgbox Error with command: %Command%`n%listname% index: Subcommand2 out of range.`nThe index you specified is %Subcommand2%.`nIt should be no larger than %Curcount%.
                returnit := 0
            }
          if (Subcommand2 <= 0) {
              if (Debug)
                Msgbox Error with command: %Command%`n%listname% index: Subcommand2 out of range.`nThe index you specified is 0.`nIt should be at least 1.
              returnit := 0
          }
          if (returnit) { ;preform only if no error has occured thusfar
              loop % Curcount - Subcommand2 + 2 {
                moveto := curcount - (a_index - 1) + 1
                movefrom := curcount - (a_index - 1)
                %Listname%%moveto% := %Listname%%movefrom%
              }
              %listname%0 ++
              %Listname%%moveto% := Subcommand1
              returnit := %listname%0
          }
       }
   }

   else if (command = "Get") {
      curcount := %listname%0
      returnit = 1
      if (Subcommand1="")
         Subcommand1 = 0
      if (subcommand1 < 0) {
         if (debug)
            msgbox Error with command: %Command%`nSubcommand1 must be greater'nthan or equal to zero.
         returnit := 0
      }
       if (Subcommand1 > Curcount) {
         if (Debug)
            Msgbox Error with command: %Command%`n%listname% index: Subcommand1 out of range.`nThe index you specified is %Subcommand1%.`nIt should be no larger than %Curcount%.
         returnit := 0
       }
       if (returnit)
         returnit := %listname%%Subcommand1%
     }

   else if (command = "GetIndex") {
       loop % %listname%0 {
         if (Subcommand1 = %listname%%A_index%) {
            returnit := A_index
            break
         }
         else {
            returnit := 0
         }
         }
         if (debug) AND !(returnit)
         Msgbox Error with command: %Command%`n%Subcommand1% does not exist within %listname%
      }

   else if (command = "Remove") {
       curcount := %listname%0
       if (subcommand1 = "") {
         if (debug)
            Msgbox Error with command: %Command%`nSubcommand1 is expected but missing.
         returnit := 0
       }
      if (subcommand1 < 0) {
         if (debug)
            msgbox Error with command: %Command%`nSubcommand1 must be greater`nthan or equal to zero.
         returnit := 0
      }
       if (returnit) AND ((subcommand1 > curcount) OR !(subcommand1)) {
         if (debug)
            Msgbox Error with command: %Command%`nSubcommand1 is out of range.`nThe value you specified is %subcommand1%.`nIt should be between 1 and %curcount%.
         returnit := 0
       }
       if (returnit) {
         loop % %listname%0 - subcommand1 {
            moveto := subcommand1 + (a_index - 1)
            movefrom := subcommand1 + (a_index - 1) + 1
            %Listname%%moveto% := %Listname%%movefrom%
         }
         AHKList(listname, "Set", %listname%0)
         %listname%0 --
         ;I chose not to blank out the old last index because if I could declare static like i do
         ;global then the user could not access the old last index anyway.
      }
   }
 
   else if (command = "Print") {
      returnit := ""
      loop % %listname%0 {
         returnit = % returnit A_index " " %Listname%%a_index% "`n"
      }
      if (debug)
         msgbox %returnit%
   }
 
   else if (command = "Pop") {
      dummy := AHKList(listname, "Get", AHKList(listname, "Get"))
      AHKList(listname, "Remove", AHKList(listname, "Get"))
      returnit := dummy
   }
   
   else if (command = "RemItem") {
      if (subcommand1 = "") {
            if (debug)
               Msgbox Error with command: %Command%`nSubcommand1 is expected but missing.
            returnit := 0
      }
      if (returnit) {
         dummy := subcommand2 = "" ? 1 : subcommand2
         if (dummy < 0 ) {
            dummy = 0
            loop % AHKList(listname, "get") {
               if (AHKList(listname, "get", a_index + dummy) = subcommand1) {
                  AHKList(listname, "remove", a_index + dummy)
                  dummy --
               }
            }
         }
         else {
            loop % AHKList(listname, "get") {
               if (dummy = 0)
                  break
               if (AHKList(listname, "get", a_index - dummy <= 0 ? 1 : a_index - dummy) = subcommand1) {
                  AHKList(listname, "remove",  a_index - dummy <= 0 ? 1 : a_index - dummy)
                  dummy --
               }
            }
         }
      }
   }
   
   else if (command = "whatsinside") {
      listvars
      msgbox Close this to continue the script
   }
   
   else if (command = "set") {
      if (Subcommand1="")
         Subcommand1 = 0
      else if (subcommand1 < 0) {
         if (debug)
            msgbox Error with command: %Command%`nSubcommand1 must be greater'nthan or equal to zero.
         returnit := 0
      }
       else if (Subcommand1 > Curcount) {
         if (Debug)
            Msgbox Error with command: %Command%`n%listname% index: Subcommand1 out of range.`nThe index you specified is %Subcommand1%.`nIt should be no larger than %Curcount%.
         returnit := 0
       }
      %listname%%Subcommand1% := subcommand2
   }
   return % returnit
}

;make a new list called fruit and add a banana to the list

ahklist("Fruit", "add", "Banana")


;to save time typing I'll define a shortcut function
;Please not that ahklist always requires the listname command

fruit(command, subcom1="", subcom2="", debug="1") {
   return % ahklist("Fruit", command, subcom1, subcom2, debug)
}

fruit("add", "Banana")
fruit("add", "Orange")
fruit("add", "Banana")
fruit("add", "Orange")
fruit("add", "Banana")
fruit("add", "Orange")

fruit("add", "Banana")
fruit("add", "Orange")
fruit("add", "Banana")
fruit("add", "Orange")
fruit("add", "Banana")
fruit("add", "Orange")
;Add a whole bunch of fruit to the mix
listvars

msgbox See There are no variables in the global scope
fruit("Whatsinside")
;The variables are all on the local scope

fruit("set", 4, "Mango")
fruit("set", 5)
;Change some values
fruit("print")

fruit("insertbefore", "This is before a mango", 4)
;insert something before the mango.  This puts Mango in the fourth location.
msgbox % fruit("get", 5) "`nSee the " fruit("getindex", "Mango") "th place is a mango."

fruit("remove", 1) ; So i was hungry
; i removed a banana and ate it.

fruit("add", "bubble")
msgbox % "I popped a " fruit("pop")

;Ok so I'll eat the first two bananas

fruit("remitem", "Banana", 2)
fruit("print")
;guess the oranges went bad better get rid of them all.
fruit("remitem", "Orange", -1)

fruit("print")

ahklist("Veggies") ; adds a blank value to the lists "Veggies"
ahklist("Veggies", "add", "Banana") ; adds "Banana" to "Veggies"
ahklist("Veggies", "add", "Orange") ; adds "Orange" to "Veggies"
ahklist("Veggies", "add", "Carrot") ; adds "Carrot" to "Veggies"
ahklist("Veggies", "InsertBefore","",1)
; inserts a blank value before the first veggie
ahklist("Veggies", "InsertBefore", "Potato", 2)
; insets "Potato" before the second index of "Veggies"
ahklist("Veggies", "Get") ; gets the count of veggies
ahklist("Veggies","GetIndex","Banana")
; searches the veggies for a banana and returns it's position
msgbox % ahklist("Veggies","get")
ahklist("mVeggiesylist","remove",1)
; removes the first veggie
msgbox % ahklist("Veggies","get")
listvars
msgbox REMEMBER TO EAT YOUR GREENS
return