1 
2 /**
3  *    Copyright (C) 2018-present MongoDB, Inc.
4  *
5  *    This program is free software: you can redistribute it and/or modify
6  *    it under the terms of the Server Side Public License, version 1,
7  *    as published by MongoDB, Inc.
8  *
9  *    This program is distributed in the hope that it will be useful,
10  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
11  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12  *    Server Side Public License for more details.
13  *
14  *    You should have received a copy of the Server Side Public License
15  *    along with this program. If not, see
16  *    <http://www.mongodb.com/licensing/server-side-public-license>.
17  *
18  *    As a special exception, the copyright holders give permission to link the
19  *    code of portions of this program with the OpenSSL library under certain
20  *    conditions as described in each individual source file and distribute
21  *    linked combinations including the program with the OpenSSL library. You
22  *    must comply with the Server Side Public License in all respects for
23  *    all of the code used other than as permitted herein. If you modify file(s)
24  *    with this exception, you may extend this exception to your version of the
25  *    file(s), but you are not obligated to do so. If you do not wish to do so,
26  *    delete this exception statement from your version. If you delete this
27  *    exception statement from all source files in the program, then also delete
28  *    it in the license file.
29  */
30 
31 #pragma once
32 
33 #include "mongo/db/ops/modifier_interface.h"
34 #include "mongo/db/update/update_leaf_node.h"
35 
36 namespace mongo {
37 namespace modifiertable {
38 
39 // NOTE: Please update jstests/verify_update_mods.js or include a jstest for any new mods
40 enum ModifierType {
41     MOD_ADD_TO_SET,
42     MOD_BIT,
43     MOD_CURRENTDATE,
44     MOD_INC,
45     MOD_MAX,
46     MOD_MIN,
47     MOD_MUL,
48     MOD_POP,
49     MOD_PULL,
50     MOD_PULL_ALL,
51     MOD_PUSH,
52     MOD_SET,
53     MOD_SET_ON_INSERT,
54     MOD_RENAME,
55     MOD_UNSET,
56     MOD_CONFLICT_PLACEHOLDER,
57     MOD_UNKNOWN
58 };
59 
60 /**
61  * Returns the modifier type for 'typeStr', if it was recognized as an existing update
62  * mod, or MOD_UNKNOWN otherwise.
63  */
64 ModifierType getType(StringData typeStr);
65 
66 /**
67  * Instantiate an update mod that corresponds to 'modType' or NULL if 'modType' is not
68  * valid. The ownership of the new object is the caller's.
69  */
70 ModifierInterface* makeUpdateMod(ModifierType modType);
71 
72 /**
73  * Instantiate an UpdateLeafNode that corresponds to 'modType' or nullptr if 'modType' is not valid.
74  */
75 std::unique_ptr<UpdateLeafNode> makeUpdateLeafNode(ModifierType modType);
76 
77 }  // namespace modifiertable
78 }  // namespace mongo
79